From 1f5d874105277853611b24d711372f54123b9e63 Mon Sep 17 00:00:00 2001 From: Aaron Hoffman Date: Sun, 16 Oct 2022 14:51:12 -0500 Subject: [PATCH 1/3] Update example release.yml in GitHub Actions doc --- ...release-your-plugin-with-github-actions.md | 117 ++++++------------ 1 file changed, 41 insertions(+), 76 deletions(-) diff --git a/docs/publishing/release-your-plugin-with-github-actions.md b/docs/publishing/release-your-plugin-with-github-actions.md index 63fc3066..0be827e7 100644 --- a/docs/publishing/release-your-plugin-with-github-actions.md +++ b/docs/publishing/release-your-plugin-with-github-actions.md @@ -21,81 +21,47 @@ The GitHub Action workflow was originally created and shared by [argentum](https jobs: build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Use Node.js - uses: actions/setup-node@v1 - with: - node-version: "14.x" - - - name: Build - id: build - run: | - npm install - npm run build - mkdir ${{ env.PLUGIN_NAME }} - cp main.js manifest.json styles.css ${{ env.PLUGIN_NAME }} - zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }} - ls - echo "::set-output name=tag_name::$(git tag --sort version:refname | tail -n 1)" - - - name: Create Release - id: create_release - uses: actions/create-release@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - VERSION: ${{ github.ref }} - with: - tag_name: ${{ github.ref }} - release_name: ${{ github.ref }} - draft: false - prerelease: false - - - name: Upload zip file - id: upload-zip - uses: actions/upload-release-asset@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: ./${{ env.PLUGIN_NAME }}.zip - asset_name: ${{ env.PLUGIN_NAME }}-${{ steps.build.outputs.tag_name }}.zip - asset_content_type: application/zip - - - name: Upload main.js - id: upload-main - uses: actions/upload-release-asset@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: ./main.js - asset_name: main.js - asset_content_type: text/javascript - - - name: Upload manifest.json - id: upload-manifest - uses: actions/upload-release-asset@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: ./manifest.json - asset_name: manifest.json - asset_content_type: application/json - - - name: Upload styles.css - id: upload-css - uses: actions/upload-release-asset@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: ./styles.css - asset_name: styles.css - asset_content_type: text/css + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 # otherwise, you will failed to push refs to dest repo + - name: Use Node.js + uses: actions/setup-node@v1 + with: + node-version: "14.x" # You might need to adjust this value to your own version + + # Get the version number and put it in an environment file + - name: Get Version + id: version + run: | + echo "tag=$(git describe --tags $(git rev-list --tags --max-count=1))" >> $GITHUB_ENV + + # Build the plugin + - name: Build + id: build + run: | + npm install + npm run build --if-present + + # Package the required files into a zip + - name: Package + run: | + mkdir ${{ github.event.repository.name }} + cp main.js manifest.json styles.css README.md ${{ github.event.repository.name }} + zip -r ${{ github.event.repository.name }}-${{ env.tag }}.zip ${{ github.event.repository.name }} + + - name: Release + uses: softprops/action-gh-release@v1 + with: + files: | + ${{ github.event.repository.name }}-${{ env.tag }}.zip + main.js + main.css + manifest.json + styles.css + ``` 1. In your terminal, commit the workflow. @@ -162,7 +128,6 @@ To enable standard-version for your plugin: - `"t": ""` configures standard-version to remove the default `v` prefix to adhere to Obsidian's guidelines. - To make a release: 1. Commit your changes according to Conventional Commits. From aeda937576ca94c870fa97ceefbd6c61cd4bf975 Mon Sep 17 00:00:00 2001 From: afhoffman Date: Sat, 29 Oct 2022 21:42:42 -0500 Subject: [PATCH 2/3] Update docs/publishing/release-your-plugin-with-github-actions.md Change `node-version` to current LTS (18.x). Co-authored-by: Marcus Olsson <8396880+marcusolsson@users.noreply.github.com> --- docs/publishing/release-your-plugin-with-github-actions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publishing/release-your-plugin-with-github-actions.md b/docs/publishing/release-your-plugin-with-github-actions.md index 0be827e7..9e346984 100644 --- a/docs/publishing/release-your-plugin-with-github-actions.md +++ b/docs/publishing/release-your-plugin-with-github-actions.md @@ -30,7 +30,7 @@ The GitHub Action workflow was originally created and shared by [argentum](https - name: Use Node.js uses: actions/setup-node@v1 with: - node-version: "14.x" # You might need to adjust this value to your own version + node-version: "18.x" # You might need to adjust this value to your own version. # Get the version number and put it in an environment file - name: Get Version From 7ea08a5fd220f57be611940ab0a53451d3dac94e Mon Sep 17 00:00:00 2001 From: afhoffman Date: Sat, 29 Oct 2022 21:46:18 -0500 Subject: [PATCH 3/3] Update docs/publishing/release-your-plugin-with-github-actions.md Remove unneeded `--if-present` in `build` section. Co-authored-by: Marcus Olsson <8396880+marcusolsson@users.noreply.github.com> --- docs/publishing/release-your-plugin-with-github-actions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publishing/release-your-plugin-with-github-actions.md b/docs/publishing/release-your-plugin-with-github-actions.md index 9e346984..f2fd6886 100644 --- a/docs/publishing/release-your-plugin-with-github-actions.md +++ b/docs/publishing/release-your-plugin-with-github-actions.md @@ -43,7 +43,7 @@ The GitHub Action workflow was originally created and shared by [argentum](https id: build run: | npm install - npm run build --if-present + npm run build # Package the required files into a zip - name: Package