-
-
Notifications
You must be signed in to change notification settings - Fork 286
Use the Publish to BCR reusable GitHub workflow #1731
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f9798f3
Use the Publish to BCR reusable GitHub workflow
mbland 7f2594d
Bump to bazel-contrib/publish-to-bcr v0.1.0
mbland b27b6b5
Bump bazel-contrib/.github release_ruleset v7.2.2
mbland 4c4fcaf
Set bazel-contrib registry_fork in publish-to-bcr
mbland 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 hidden or 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,16 +1,70 @@ | ||
| # Bazel Central Registry publication | ||
|
|
||
| The [Publish to BCR GitHub app](https://github.com/bazel-contrib/publish-to-bcr) | ||
| uses these configuration files for publishing Bazel modules to the [Bazel | ||
| Central Registry (BCR)](https://registry.bazel.build/). | ||
| [.github/workflows/publish-to-bcr.yml](../.github/workflows/publish-to-bcr.yml) | ||
| uses these files to configure the [Publish to BCR]( | ||
| https://github.com/bazel-contrib/publish-to-bcr) workflow for publishing to the | ||
| [Bazel Central Registry (BCR)](https://registry.bazel.build/). | ||
|
|
||
| - [Publish to BCR workflow setup]( | ||
| https://github.com/bazel-contrib/publish-to-bcr/tree/main/README.md#setup) | ||
| https://github.com/bazel-contrib/publish-to-bcr?tab=readme-ov-file#setup) | ||
| - [.bcr/ templates]( | ||
| https://github.com/bazel-contrib/publish-to-bcr/tree/main/templates) | ||
| - [.github/workflows/publish.yaml reusable workflow]( | ||
| https://github.com/bazel-contrib/publish-to-bcr/blob/main/.github/workflows/publish.yaml) | ||
|
|
||
| Related documentation: | ||
| Notice that the setup instructions suggest saving the Personal Access Token as | ||
| `PUBLISH_TOKEN`. We save it as `BCR_PUBLISH_TOKEN` instead, as inspired by | ||
| aspect-build/rules_lint#529, to make this value more self documenting. | ||
|
|
||
| ## Provenance attestations | ||
|
|
||
| This workflow also produces attestations required by the [Supply chain Levels | ||
| for Software Artifacts (SLSA)](https://slsa.dev/) framework for secure supply | ||
| chain provenance. | ||
|
|
||
| Examples: | ||
|
|
||
| <!-- Replace these with rules_scala examples once they're available. --> | ||
| - [aspect-build/rules_lint v1.3.4 release and publish run with attestations]( | ||
| https://github.com/aspect-build/rules_lint/actions/runs/14410869652/attempts/1) | ||
| - [aspect-build/rules_lint v1.3.4 attestations]( | ||
| https://github.com/aspect-build/rules_lint/attestations/6280291) | ||
| - [aspect-build/rules_lint attestations]( | ||
| https://github.com/aspect-build/rules_lint/attestations) | ||
|
|
||
| ## Related documentation | ||
|
|
||
| - [bazelbuild/bazel-central-registry]( | ||
| https://github.com/bazelbuild/bazel-central-registry) | ||
| - [SLSA: Provenance](https://slsa.dev/spec/v1.0/provenance) | ||
| - [in-toto](https://in-toto.io/) | ||
| - [GitHub Actions](https://docs.github.com/actions) | ||
| - [Security for GitHub Actions]( | ||
| https://docs.github.com/en/actions/security-for-github-actions) | ||
| - [Using secrets in a workflow]( | ||
| https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#using-secrets-in-a-workflow) | ||
| - [Using artifact attestations]( | ||
| https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations) | ||
| - [Writing Workflows]( | ||
| https://docs.github.com/en/actions/writing-workflows) | ||
| - [Accessing contextual information about workflow runs: 'secrets' context]( | ||
| https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#secrets-context) | ||
| - [Workflow syntax for GitHub Action: 'on.workflow_call.secrets']( | ||
| https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onworkflow_callsecrets) | ||
| - [Sharing automations](https://docs.github.com/en/actions/sharing-automations) | ||
| - [Passing inputs and secrets to a reusable workflow]( | ||
| https://docs.github.com/en/actions/sharing-automations/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow) | ||
| - [actions/attest-build-provenance]( | ||
| https://github.com/actions/attest-build-provenance) | ||
| - [in-toto/attestation](https://github.com/in-toto/attestation) | ||
| - [slsa-framework/slsa-verifier]( | ||
| https://github.com/slsa-framework/slsa-verifier) | ||
|
|
||
| ## Inspiration | ||
|
|
||
| Originally based on the examples from aspect-build/rules_lint#498 and | ||
| aspect-build/rules_lint#501. See also: | ||
|
|
||
| - bazelbuild/bazel-central-registry#4060 | ||
| - bazelbuild/bazel-central-registry#4146 | ||
| - slsa-framework/slsa-verifier#840 |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Publishes to the Bazel Central Registry. | ||
| # | ||
| # Based on .github/workflows/publish.yaml from aspect-build/rules_lint v1.3.5. | ||
| # See .bcr/README.md. | ||
| name: Publish to the Bazel Central Registry | ||
|
|
||
| on: | ||
| # Run from release.yml. | ||
| workflow_call: | ||
| inputs: | ||
| tag_name: | ||
| required: true | ||
| type: string | ||
| secrets: | ||
| bcr_publish_token: | ||
| required: true | ||
|
|
||
| # In case of problems, enable manual dispatch from the GitHub UI. | ||
| workflow_dispatch: | ||
| inputs: | ||
| tag_name: | ||
| required: true | ||
| type: string | ||
|
|
||
| jobs: | ||
| publish-to-bcr: | ||
| uses: bazel-contrib/publish-to-bcr/.github/workflows/[email protected] | ||
| with: | ||
| tag_name: ${{ inputs.tag_name }} | ||
| # bazelbuild/bazel-central-registry fork used to open a pull request. | ||
| registry_fork: bazel-contrib/bazel-central-registry | ||
| permissions: | ||
| attestations: write | ||
| contents: write | ||
| id-token: write | ||
| secrets: | ||
| # Necessary to push to the BCR fork and open a pull request. | ||
| publish_token: ${{ secrets.bcr_publish_token }} | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -7,21 +7,38 @@ on: | |
| tags: | ||
| - 'v*.*.*' | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| # In case of problems, enable manual dispatch from the GitHub UI. | ||
| workflow_dispatch: | ||
| inputs: | ||
| tag_name: | ||
| required: true | ||
| type: string | ||
|
|
||
| # Uses the `release_ruleset` workflow to generate provenance attestation files | ||
| # referenced by the `publish-to-bcr` workflow. | ||
| # | ||
| # Based on .github/workflows/release.yml from aspect-build/rules_lint v1.3.5. | ||
| # See .bcr/README.md. | ||
|
|
||
| - name: Prepare workspace snippet | ||
| run: .github/workflows/workspace_snippet.sh ${{ env.GITHUB_REF_NAME }} > release_notes.txt | ||
| permissions: | ||
| attestations: write # Needed to attest provenance | ||
| contents: write # Needed to create release | ||
| id-token: write # Needed to attest provenance | ||
|
|
||
| jobs: | ||
| release: | ||
| uses: bazel-contrib/.github/.github/workflows/[email protected] | ||
| with: | ||
| bazel_test_command: "bazel test //src/... //test/... //third_party/..." | ||
| prerelease: false | ||
| release_files: rules_scala-*.tar.gz | ||
| release_prep_command: .github/workflows/workspace_snippet.sh | ||
| tag_name: ${{ inputs.tag_name || github.ref_name }} | ||
|
|
||
| - name: Release | ||
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| # Use GH feature to populate the changelog automatically | ||
| generate_release_notes: true | ||
| body_path: release_notes.txt | ||
| fail_on_unmatched_files: true | ||
| files: rules_scala-*.tar.gz | ||
| publish-to-bcr: | ||
| needs: release | ||
| uses: ./.github/workflows/publish-to-bcr.yml | ||
| with: | ||
| tag_name: ${{ inputs.tag_name || github.ref_name }} | ||
| secrets: | ||
| bcr_publish_token: ${{ secrets.bcr_publish_token }} | ||
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.
If you are using @aspect-marvin as the PR author, I suggest setting
draft: false(it defaults to true). Removes one step you have to do to merge the PR.The draft option was added because authors can't approve their own PRs on the BCR. The BCR team wants to use clicking the "Ready for review" button as a mechanism to approve the PR in those cases.