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.

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

fix: The GITHUB_ prefix was unusable #437

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

snickerjp
Copy link
Contributor

@snickerjp snickerjp commented Dec 2, 2024

Pull Request

The GITHUB_ prefix is no longer supported in GitHub Actions secrets, so I updated the relevant documentation in docs/authenticating-with-github-app-installation.md.

Proposed Changes

Fixes #436.

  • Updated docs/authenticating-with-github-app-installation.md to clarify that the GITHUB_ prefix is no longer supported in GitHub Actions secrets.
  • No other files or configurations were modified in this PR.

Validation

  • I verified the changes by running workflows in my personal repository, and all Actions completed successfully.

Readiness Checklist

Author/Contributor

  • Documentation updates are included in this pull request (docs/authenticating-with-github-app-installation.md)
  • Run make lint and fix any issues that you have introduced
  • Run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as documentation to indicate that this change exclusively updates documentation.

@jmeridth
Copy link
Member

jmeridth commented Dec 2, 2024

Nice catch about custom secrets not allowed to have the GITHUB_ prefix. TIL Naming standards/restrictions. The GITHUB_TOKEN is still valid. It is the default token given to a GitHub Action Workflow so it can interact with itself.

This PR would need to include updates to the README.md and source code that uses the environment variables. Do you agree?

This would also be a breaking change and require a major version update for releases. This will need to happen on the other GitHub OSPO Actions. You up for updating this PR (README and code) and getting others out for the other actions or do we divide and conquer? I'm not trying to steal your thunder. 😄

@jmeridth
Copy link
Member

jmeridth commented Dec 2, 2024

I have to admit, I've successfully run all of these actions with the GITHUB_* prefixed custom secrets. I'm curious how this is erroring now. Still, it does violate the naming convention (stated as far back as 1/2023) for custom secrets. Need to fix.

@snickerjp
Copy link
Contributor Author

@jmeridth
Thank you for pointing that out. Since the GITHUB_TOKEN is still valid, I will revert the changes related to this part.

@jmeridth
Copy link
Member

jmeridth commented Dec 2, 2024

@jmeridth Thank you for pointing that out. Since the GITHUB_TOKEN is still valid, I will revert the changes related to this part.

Thank you. Did you see my other request for this to truly be "fixed" we need changes to README.md and the code?

@snickerjp
Copy link
Contributor Author

Thank you for your follow-up.

Thank you for your input!

@jmeridth
Copy link
Member

jmeridth commented Dec 2, 2024

@snickerjp you are correct. we already resolved this in the README and code. 🤦

Thank you for your PR.

@jmeridth jmeridth merged commit 8a76c34 into github:main Dec 2, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GITHUB_ prefix no longer supported in GitHub Actions secrets
2 participants