Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: update highlightjs mechanism #70

Merged
merged 6 commits into from
Nov 10, 2023
Merged

build: update highlightjs mechanism #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0c0647c
build(docs): update highlight.js scripts
dschach Nov 10, 2023
a65fbb6
ci(sf cli): test hardened auth usage
dschach Nov 10, 2023
9bdfad2
update codecov workflow
dschach Nov 10, 2023
04ed93c
docs: readme toc
dschach Nov 10, 2023
c47df4a
docs: update ApexDox
dschach Nov 10, 2023
e252574
revert codecov update - move to new PR
dschach Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Duplicate Management Enhancements
# Duplicate Management Enhancements <!-- omit in toc -->

![License](https://img.shields.io/github/license/dschach/duplicatehandling)
[![CI](https://github.com/dschach/duplicatehandling/actions/workflows/ci.yml/badge.svg)](https://github.com/dschach/duplicatehandling/actions/workflows/ci.yml)
Expand All @@ -10,13 +10,14 @@

## [Changelog](./CHANGELOG.md)

## Table of contents
## Table of contents <!-- omit in toc -->

- [Quick Deploy](#quick-deploy): Fast, easy installation of this repository into any org.

- [Installing the app using a Scratch Org](#installing-the-app-using-a-scratch-org): This is the recommended installation option. Use this option if you are a developer who wants to experience the app and the code.

- [Installing the app using a Developer Edition Org or a Trailhead Playground](#installing-the-app-using-a-developer-edition-org-or-a-trailhead-playground): Useful when tackling Trailhead Badges or if you want the app deployed to a more permanent environment than a Scratch org.
- [Changelog](#changelog)
- [Package Installation](#package-installation)
- [Quick Deploy](#quick-deploy)
- [Installing the app using a Scratch Org](#installing-the-app-using-a-scratch-org)
- [Installing the app using a Scratch Org (Step-by-step)](#installing-the-app-using-a-scratch-org-step-by-step)
- [Installing the App using a Developer Edition Org or a Trailhead Playground](#installing-the-app-using-a-developer-edition-org-or-a-trailhead-playground)

## Package Installation

Expand All @@ -31,14 +32,14 @@

<br/>

## Quick Deploy
### Quick Deploy

<a href="https://githubsfdeploy.herokuapp.com">
<img alt="Deploy to Salesforce"
src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
</a>

## Installing the app using a Scratch Org
### Installing the app using a Scratch Org

1. Set up your environment. Follow the steps in the [Quick Start: Lightning Web Components](https://trailhead.salesforce.com/content/learn/projects/quick-start-lightning-web-components/) Trailhead project. The steps include:

Expand Down Expand Up @@ -67,7 +68,7 @@

That's it!

## Installing the app using a Scratch Org (Step-by-step)
### Installing the app using a Scratch Org (Step-by-step)

1. Set up your environment. Follow the steps in the [Quick Start: Lightning Web Components](https://trailhead.salesforce.com/content/learn/projects/quick-start-lightning-web-components/) Trailhead project. The steps include:

Expand Down Expand Up @@ -113,7 +114,7 @@ That's it!
sf org open
```

## Installing the App using a Developer Edition Org or a Trailhead Playground
### Installing the App using a Developer Edition Org or a Trailhead Playground

Follow this set of instructions if you want to deploy the app to a more permanent environment than a Scratch org.
This includes non source-tracked orgs such as a [free Developer Edition Org](https://developer.salesforce.com/signup) or a [Trailhead Playground](https://trailhead.salesforce.com/).
Expand Down
2 changes: 2 additions & 0 deletions apexdox.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ engine:
- '${workspaceFolder}/doc-assets/highlight.css'
- '${workspaceFolder}/doc-assets/highlight.js'
- '${workspaceFolder}/doc-assets/index.js'
- '${workspaceFolder}/media/deploy-package-to-prod.png'
- '${workspaceFolder}/media/deploy-package-to-sandbox.png'
# - "${workspaceFolder}/documentation/meme.jpg"
port: 9090
docblock:
Expand Down
359 changes: 202 additions & 157 deletions doc-assets/highlight.js
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 15 additions & 13 deletions doc-assets/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<link href="assets/styling.css" rel="stylesheet" />
<h1>Duplicate Management Enhancements</h1>
<h1>Duplicate Management Enhancements <!-- omit in toc --></h1>
<p><img src="https://img.shields.io/github/license/dschach/duplicatehandling" alt="License">
<a href="https://github.com/dschach/duplicatehandling/actions/workflows/ci.yml"><img src="https://github.com/dschach/duplicatehandling/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
<a href="https://github.com/dschach/duplicatehandling/actions/workflows/codecov.yml"><img src="https://github.com/dschach/duplicatehandling/actions/workflows/codecov.yml/badge.svg" alt="coverage check"></a>
Expand All @@ -9,34 +9,36 @@ <h1>Duplicate Management Enhancements</h1>
<p>This application is designed to run on the Salesforce Platform.</p>
</blockquote>
<h2><a href="./changelog.html">Changelog</a></h2>
<h2>Table of contents</h2>
<h2>Table of contents <!-- omit in toc --></h2>
<ul>
<li><p><a href="#quick-deploy">Quick Deploy</a>: Fast, easy installation of this repository into any org.</p>
</li>
<li><p><a href="#installing-the-app-using-a-scratch-org">Installing the app using a Scratch Org</a>: This is the recommended installation option. Use this option if you are a developer who wants to experience the app and the code.</p>
</li>
<li><p><a href="#installing-the-app-using-a-developer-edition-org-or-a-trailhead-playground">Installing the app using a Developer Edition Org or a Trailhead Playground</a>: Useful when tackling Trailhead Badges or if you want the app deployed to a more permanent environment than a Scratch org.</p>
<li><a href="#changelog">Changelog</a></li>
<li><a href="#package-installation">Package Installation</a><ul>
<li><a href="#quick-deploy">Quick Deploy</a></li>
<li><a href="#installing-the-app-using-a-scratch-org">Installing the app using a Scratch Org</a></li>
<li><a href="#installing-the-app-using-a-scratch-org-step-by-step">Installing the app using a Scratch Org (Step-by-step)</a></li>
<li><a href="#installing-the-app-using-a-developer-edition-org-or-a-trailhead-playground">Installing the App using a Developer Edition Org or a Trailhead Playground</a></li>
</ul>
</li>
</ul>
<h2>Package Installation</h2>
<a href="https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3a000000LdirAAC">
<img alt="Deploy to Salesforce"
src="./media/deploy-package-to-prod.png">
src="./assets/deploy-package-to-prod.png">
</a>
<a href="https://test.salesforce.com/packaging/installPackage.apexp?p0=04t3a000000LdirAAC">
<img alt="Deploy to Salesforce Sandbox"
src="./media/deploy-package-to-sandbox.png">
src="./assets/deploy-package-to-sandbox.png">
</a>

<br/>

<h2>Quick Deploy</h2>
<h3>Quick Deploy</h3>
<a href="https://githubsfdeploy.herokuapp.com">
<img alt="Deploy to Salesforce"
src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
</a>

<h2>Installing the app using a Scratch Org</h2>
<h3>Installing the app using a Scratch Org</h3>
<ol>
<li><p>Set up your environment. Follow the steps in the <a href="https://trailhead.salesforce.com/content/learn/projects/quick-start-lightning-web-components/">Quick Start: Lightning Web Components</a> Trailhead project. The steps include:</p>
<ul>
Expand All @@ -61,7 +63,7 @@ <h2>Installing the app using a Scratch Org</h2>
</li>
</ol>
<p>That&#39;s it!</p>
<h2>Installing the app using a Scratch Org (Step-by-step)</h2>
<h3>Installing the app using a Scratch Org (Step-by-step)</h3>
<ol>
<li><p>Set up your environment. Follow the steps in the <a href="https://trailhead.salesforce.com/content/learn/projects/quick-start-lightning-web-components/">Quick Start: Lightning Web Components</a> Trailhead project. The steps include:</p>
<ul>
Expand Down Expand Up @@ -97,7 +99,7 @@ <h2>Installing the app using a Scratch Org (Step-by-step)</h2>
</code></pre>
</li>
</ol>
<h2>Installing the App using a Developer Edition Org or a Trailhead Playground</h2>
<h3>Installing the App using a Developer Edition Org or a Trailhead Playground</h3>
<p>Follow this set of instructions if you want to deploy the app to a more permanent environment than a Scratch org.
This includes non source-tracked orgs such as a <a href="https://developer.salesforce.com/signup">free Developer Edition Org</a> or a <a href="https://trailhead.salesforce.com/">Trailhead Playground</a>.</p>
<p>Make sure to start from a brand-new environment to avoid conflicts with previous work you may have done.</p>
Expand Down
1 change: 1 addition & 0 deletions doc-assets/setupApexDox.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ printf '<link href="assets/styling.css" rel="stylesheet" />' > "doc-assets/chang
echo >> "doc-assets/changelog.html"
npx marked -i CHANGELOG.md --gfm >> "doc-assets/changelog.html"
sed -i "" "s|CHANGELOG.md|changelog.html|" "doc-assets/main.html"
sed -i "" "s|./media|./assets|" "doc-assets/main.html"

. doc-assets/updateHighlight.sh
3 changes: 2 additions & 1 deletion doc-assets/updateHighlight.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#!/bin/sh

FILE=node_modules/@highlightjs/cdn-assets/highlight.min.js
if test -f "$FILE"; then
if test -f $FILE; then
echo "module installed"
cat node_modules/@highlightjs/cdn-assets/highlight.min.js > doc-assets/highlight.js
echo "\n" >> doc-assets/highlight.js
cat node_modules/highlightjs-apex/dist/apex.min.js >> doc-assets/highlight.js
Expand Down
Binary file added docs/assets/deploy-package-to-prod.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/deploy-package-to-sandbox.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
359 changes: 202 additions & 157 deletions docs/assets/highlight.js
View file
Open in desktop

Large diffs are not rendered by default.

Loading