refactor: use secrets: inherit by default in ci.yml & Web Generator - #28
Closed
lwaldron wants to merge 1 commit into
Closed
refactor: use secrets: inherit by default in ci.yml & Web Generator#28lwaldron wants to merge 1 commit into
lwaldron wants to merge 1 commit into
Conversation
…. Co-authored-by: Antigravity <gemini@google.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the caller workflow template (ci.yml) and the web-based workflow generator (docs/index.html) to use secrets: inherit by default when calling the reusable bioccheck.yml workflow, and adjusts bioccheck_usage.md to reflect the new secret-passing behavior.
Changes:
- Switch the
ci.ymltemplate from commented explicit secret mapping tosecrets: inherit. - Update the workflow generator to always include
secrets: inheritand remove the Codecov UI toggle and related generation logic. - Update the Codecov setup documentation to state the token is passed automatically via
secrets: inherit.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/index.html | Generates caller workflows that always use secrets: inherit when invoking bioccheck.yml. |
| ci.yml | Changes the example caller workflow to pass all secrets to the reusable workflow by default. |
| bioccheck_usage.md | Updates Codecov setup instructions to reference secrets: inherit behavior. |
Comment on lines
367
to
371
| bioccheck: { | ||
| uses: 'bioconductor/workflows/.github/workflows/bioccheck.yml@main', | ||
| with: {} | ||
| with: {}, | ||
| secrets: 'inherit' | ||
| } |
| # Required only if you want test coverage via Codecov | ||
| # secrets: | ||
| # CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} No newline at end of file | ||
| secrets: inherit No newline at end of file |
| **For Codecov:** | ||
| 1. **Obtain Codecov Token**: Log in to [Codecov](https://about.codecov.io/), link your repository, and copy the repository upload token. | ||
| 2. **Set Repository Secret**: In your GitHub repository, navigate to **Settings** → **Secrets and variables** → **Actions** → **New repository secret**. Create a secret named `CODECOV_TOKEN` containing your token. | ||
| 2. **Set Repository Secret**: In your GitHub repository, navigate to **Settings** → **Secrets and variables** → **Actions** → **New repository secret**. Create a secret named `CODECOV_TOKEN` containing your token. Because `ci.yml` uses `secrets: inherit`, the token is passed to the workflow automatically. |
Collaborator
Author
|
Deciding not to use |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
ci.yml: Replaced commented secret mapping block withsecrets: inherit. This allows any repository secrets (such asCODECOV_TOKEN) to be passed down automatically to the reusable workflow without requiring maintainers to manually uncomment lines.docs/index.html): Updated JS generator logic to includesecrets: inheritby default and simplified the UI form.bioccheck_usage.md): Updated Codecov setup section to note thatsecrets: inherithandles token passing automatically.