-
Notifications
You must be signed in to change notification settings - Fork 326
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
MAINT - CI improvements (security and maintenance) #2077
base: main
Are you sure you want to change the base?
MAINT - CI improvements (security and maintenance) #2077
Conversation
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
uses: ./.github/workflows/CI.yml | ||
# needed for the coverage action |
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.
Once this is merged, this will need pinning to a SHA.
tests: | ||
uses: ./.github/workflows/CI.yml | ||
# needed for the coverage action | ||
permissions: | ||
contents: write | ||
pull-requests: write | ||
# calls our docs workflow (build docs, check broken links, lighthouse) | ||
docs: | ||
uses: ./.github/workflows/docs.yml |
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.
Once this is merged, this will need pinning to a SHA.
runs-on: ubuntu-latest | ||
needs: [build-package] | ||
permissions: | ||
id-token: write # needed for PyPI upload | ||
environment: |
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.
Double-checking that this GitHub Environment is required on the Trusted Publisher in PyPI?
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.
I added it to my checklist so I remember to add it
my fixes to STB were done in May and August of 2023, and the most recent release was March 2023. So we do still need the pin (or to install from tip of
I don't remember creating it. But it might have been me. Are we pushing nightlies to the scientific python channel or something, is that what it's used for? |
@drammock yes we are using the Scientific Python channel so I am pretty confident it was you then.
ha! I can do both, use |
ok, feel free to do whatever you need to w/r/t org vs repo vs env secrets, and LMK if/when you want a second opinion. |
@drammock if you could create a new token for the Scientific Python nightly and add it to the pst-release environment here in the repo that would be grand so that we can keep all things related to releases in that env. |
OK this is done now, sorry for the delay @trallard. It's added with name |
I thought I would do some winter/summer cleaning (depending on your location) βπ.
This PR adds several improvements/updates to our CI with a focus on improving the contributor experience and security
Details below:
π Security focused
workflow_run
forworkflow_call
and use as a reusable workflowpst-release
environment in the repo (restricted tomain
only)pst-release
for ourrelease-PST
step inpublish.yml
pst-release
as the default env in PyPIzizmor.yml
workflow to run static analysis on our GH workflowspersist-credentials: false
to relevant actions (where we do not need further git operations)π©π½βπ€ Contributor experience
pre-release.yml
workflow from running in repos not under thepydata
org (forks)CI.yml
: pytest, a11y-tests, profiling, coveragedocs.yml
: docs-related checks like building across OSes and Python and Sphinx versions, check for broken links (new, note that I had to fix some broken links to get this in π and there seem to be still some others to fix)tox run -e docs-linkcheck
to check for broken links in our docs𧰠Maintenance
3.13
to our testing matrices (3.12
is left as thedefault
until we are confident all is ok with3.13
)ubuntu-22.04
target asubuntu-latest
will soon be24.04
(being rolled out right now) -> I think I might actually have explicit versions on both and only change to latest (or not) when the rollout is completedQuestions / notes
"sphinx-theme-builder @ https://github.com/pradyunsg/sphinx-theme-builder/archive/87214d0671c943992c05e3db01dca997e156e8d6.zip",
in ourproject. tool
andtox.ini
. I do not believe this pin is needed anymore, so I would like to remove it, too. WDYT?github-pages
environment that I do not think we are using, so I'd like to delete it.PYPI_TOKEN,
which should have been removed when we changed to trusted publishers.