-
-
Notifications
You must be signed in to change notification settings - Fork 90
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.
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
chore: try out release flow #1023
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,75 @@ | ||
|
|
||
| name: Security - CodeQL | ||
|
|
||
| on: | ||
| merge_group: | ||
| push: | ||
| branches: | ||
| - main | ||
| - dev | ||
| - release/* | ||
| - v2 | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| - dev | ||
| - release/* | ||
| - v2 | ||
| schedule: | ||
| - cron: "0 0 * * 1" | ||
| merge_group: | ||
| push: | ||
| branches: | ||
| - main | ||
| - dev | ||
| - release/* | ||
| - v2 | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| - dev | ||
| - release/* | ||
| - v2 | ||
| schedule: | ||
| - cron: '0 0 * * 1' | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| contents: read | ||
|
|
||
| jobs: | ||
| analyze: | ||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
| name: Analyze | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: ["javascript", "typescript"] | ||
| # CodeQL supports [ $supported-codeql-languages ] | ||
| # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||
| analyze: | ||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
| name: Analyze | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: ['javascript', 'typescript'] | ||
| # CodeQL supports [ $supported-codeql-languages ] | ||
| # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||
|
|
||
| steps: | ||
| - name: Harden Runner | ||
| uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1 | ||
| with: | ||
| egress-policy: audit | ||
| steps: | ||
| - name: Harden Runner | ||
| uses: step-security/[email protected] | ||
| with: | ||
| egress-policy: audit | ||
|
|
||
| - name: Checkout repository | ||
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | ||
| - name: Checkout repository | ||
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | ||
|
|
||
| # Initializes the CodeQL tools for scanning. | ||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/[email protected] | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| # If you wish to specify custom queries, you can do so here or in a config file. | ||
| # By default, queries listed here will override any specified in a config file. | ||
| # Prefix the list here with "+" to use these queries and those in the config file. | ||
| # Initializes the CodeQL tools for scanning. | ||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/[email protected] | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| # If you wish to specify custom queries, you can do so here or in a config file. | ||
| # By default, queries listed here will override any specified in a config file. | ||
| # Prefix the list here with "+" to use these queries and those in the config file. | ||
|
|
||
| # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). | ||
| # If this step fails, then you should remove it and run the build manually (see below) | ||
| - name: Autobuild | ||
| uses: github/codeql-action/autobuild@1500a131381b66de0c52ac28abb13cd79f4b7ecc # v2.22.12 | ||
| # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). | ||
| # If this step fails, then you should remove it and run the build manually (see below) | ||
| - name: Autobuild | ||
| uses: github/codeql-action/[email protected] | ||
|
|
||
| # ℹ️ Command-line programs to run using the OS shell. | ||
| # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||
| # ℹ️ Command-line programs to run using the OS shell. | ||
| # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||
|
|
||
| # If the Autobuild fails above, remove it and uncomment the following three lines. | ||
| # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. | ||
| # If the Autobuild fails above, remove it and uncomment the following three lines. | ||
| # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. | ||
|
|
||
| # - run: | | ||
| # echo "Run, Build Application using script" | ||
| # ./location_of_script_within_repo/buildscript.sh | ||
| # - run: | | ||
| # echo "Run, Build Application using script" | ||
| # ./location_of_script_within_repo/buildscript.sh | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@1500a131381b66de0c52ac28abb13cd79f4b7ecc # v2.22.12 | ||
| with: | ||
| category: "/language:${{matrix.language}}" | ||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/[email protected] | ||
| with: | ||
| category: '/language:${{matrix.language}}' | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,60 @@ | ||
|
|
||
|
|
||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main # Your main branch | ||
| - dev # Your development branch | ||
| - release/* # Your releases branch | ||
| # - v2 # Your current v2 branch - disabled for now because I don't know if you want to have this tag on this branch or not -_- | ||
| # TODO: Rename your V2 brach to release/v2 for proper versioning if you intend to use a Release branch method | ||
| push: | ||
| branches: | ||
| - main # Your main branch | ||
| - dev # Your development branch | ||
| - release/* # Your releases branch | ||
| - v2 # Temp V2 integration branch | ||
|
|
||
| permissions: | ||
| contents: read | ||
| contents: read | ||
|
|
||
| name: Management - Release Workflow | ||
|
|
||
| jobs: | ||
| release: | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.BOT_TOKEN || github.token }} # Bot Token is a PAT for a automation account. | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| # Harden-Runner provides runtime security for GitHub-hosted and self-hosted environments. | ||
| - name: Harden Runner | ||
| uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1 | ||
| with: | ||
| egress-policy: audit | ||
|
|
||
| # This tells you useful infomation about the workflow, but it's not required (hence commented out) - it's just nice to have | ||
| # - name: Workflow Telemetry | ||
| # uses: catchpoint/workflow-telemetry-action@6705383eabd01833acfe8412ec697384830e1455 # v1.8.7 | ||
| # with: | ||
| # comment_on_pr: false | ||
| # theme: dark | ||
| # proc_trace_sys_enable: true | ||
|
|
||
| - uses: google-github-actions/release-please-action@v4 | ||
| id: release | ||
| with: | ||
| config-file: '.github/release/release-main-config.json' | ||
| manifest-file: '.github/release/.release-manifest.json' | ||
| target-branch: ${{ github.ref_name == 'dev' && 'main' || github.ref_name }} | ||
| include-component-in-tag: true | ||
|
|
||
| - uses: actions/checkout@v4 | ||
| if: ${{ steps.release.outputs.release_created }} | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| if: ${{ steps.release.outputs.release_created }} | ||
| with: | ||
| node-version: 12 | ||
| registry-url: 'https://registry.npmjs.org' | ||
|
|
||
| - run: pnpm i # Install using pnpm | ||
| if: ${{ steps.release.outputs.release_created }} | ||
|
|
||
| - run: pnpm publish-all # Publish using pre-defined pnpm script | ||
| if: ${{ steps.release.outputs.release_created }} | ||
| release: | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} | ||
|
|
||
|
|
||
| GITHUB_TOKEN: ${{ secrets.BOT_TOKEN || github.token }} # Bot Token is a PAT for a automation account. | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| # Harden-Runner provides runtime security for GitHub-hosted and self-hosted environments. | ||
| - name: Harden Runner | ||
| uses: step-security/[email protected] | ||
| with: | ||
| egress-policy: audit | ||
|
|
||
| # This tells you useful infomation about the workflow, but it's not required (hence commented out) - it's just nice to have | ||
| # - name: Workflow Telemetry | ||
| # uses: catchpoint/[email protected] | ||
| # with: | ||
| # comment_on_pr: false | ||
| # theme: dark | ||
| # proc_trace_sys_enable: true | ||
|
|
||
| - uses: google-github-actions/release-please-action@v4 | ||
| id: release | ||
| with: | ||
| config-file: '.github/release/release-main-config.json' | ||
| manifest-file: '.github/release/.release-manifest.json' | ||
| target-branch: ${{ github.ref_name == 'dev' && 'main' || github.ref_name }} | ||
| include-component-in-tag: true | ||
|
|
||
| - uses: actions/checkout@v4 | ||
| if: ${{ steps.release.outputs.release_created }} | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| if: ${{ steps.release.outputs.release_created }} | ||
| with: | ||
| node-version: 12 | ||
| registry-url: 'https://registry.npmjs.org' | ||
|
|
||
| - run: pnpm i # Install using pnpm | ||
| if: ${{ steps.release.outputs.release_created }} | ||
|
|
||
| - run: pnpm publish-test # Publish using pre-defined pnpm script | ||
| if: ${{ steps.release.outputs.release_created }} | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The use of specific versions for actions like
checkout,codeql-action/init,codeql-action/autobuild, andcodeql-action/analyzeensures stability and predictability in the workflow execution. However, it's important to periodically review and update these versions to incorporate improvements and security patches.Consider setting up a periodic review process to ensure action versions used in the workflow are up-to-date, balancing stability with the benefits of new features and security enhancements.