Skip to content

Conversation

JamesMGreene
Copy link
Contributor

@JamesMGreene JamesMGreene commented Aug 19, 2022

Updates all GitHub Pages starter workflows to use the newly released actions/configure-pages@v2. ⬆️

Fixes #1673

Addresses:

Pre-requisites

  • Prior to submitting a new workflow, please apply to join the GitHub Technology Partner Program: partner.github.com/apply.
    • I am currently an active GitHub employee :octocat:

Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.


Tasks

For all workflows, the workflow:

  • Should be contained in a .yml file with the language or platform as its filename, in lower, kebab-cased format (for example, docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
  • Should use sentence case for the names of workflows and steps (for example, "Run tests").
  • Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
  • Should include comments in the workflow for any parts that are not obvious or could use clarification.
  • Should specify least priviledge permissions for GITHUB_TOKEN so that the workflow runs successfully.

For CI workflows, the workflow:

  • Should be preserved under the ci directory.
  • Should include a matching ci/properties/*.properties.json file (for example, ci/properties/docker-publish.properties.json).
  • Should run on push to branches: [ $default-branch ] and pull_request to branches: [ $default-branch ].
  • Packaging workflows should run on release with types: [ created ].
  • Publishing workflows should have a filename that is the name of the language or platform, in lower case, followed by "-publish" (for example, docker-publish.yml).

For Code Scanning workflows, the workflow:

  • Should be preserved under the code-scanning directory.
  • Should include a matching code-scanning/properties/*.properties.json file (for example, code-scanning/properties/codeql.properties.json), with properties set as follows:
    • name: Name of the Code Scanning integration.
    • organization: Name of the organization producing the Code Scanning integration.
    • description: Short description of the Code Scanning integration.
    • categories: Array of languages supported by the Code Scanning integration.
    • iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in the icons directory.
  • Should run on push to branches: [ $default-branch, $protected-branches ] and pull_request to branches: [ $default-branch ]. We also recommend a schedule trigger of cron: $cron-weekly (for example, codeql.yml).

Some general notes:

  • This workflow must only use actions that are produced by GitHub, in the actions organization, or
  • This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. We require that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
    # This workflow uses actions that are not certified by GitHub.
    # They are provided by a third-party and are governed by
    # separate terms of service, privacy policy, and support
    # documentation.
    
  • Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
  • Automation and CI workflows cannot be dependent on a paid service or product.

pages/jekyll.yml Outdated
uses: actions/configure-pages@v1
- run: bundle exec jekyll build --baseurl ${{ steps.pages.outputs.base_path }} # defaults output to '/_site'
uses: actions/configure-pages@v2
- run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" # defaults output to '/_site'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The quotes are important here in case base_path returns an empty string.

Alternatively, we could maybe use toJson(...). 🤔 🤷🏻‍♂️

@JamesMGreene JamesMGreene force-pushed the use-configure-pages-v2 branch from 50ee897 to bff759f Compare August 22, 2022 21:45
ashee added a commit to ashee/sheesoft.github.io that referenced this pull request Aug 25, 2022
@JamesMGreene JamesMGreene force-pushed the use-configure-pages-v2 branch from edb5a5a to 0d82602 Compare August 26, 2022 03:46
@JamesMGreene
Copy link
Contributor Author

This was effectively verified by the issue submitter in #1673.

Additionally, I utilized the Pages team's existing regression test repository setup to verify that they all still succeeded using these updated starter workflows -- everything passed. ✅ 🚀

@JamesMGreene JamesMGreene marked this pull request as ready for review August 26, 2022 04:05
@JamesMGreene JamesMGreene requested review from a team as code owners August 26, 2022 04:05
@github-actions github-actions bot requested a review from bishal-pdMSFT August 26, 2022 04:06
@JamesMGreene JamesMGreene merged commit edae9e9 into main Aug 26, 2022
@JamesMGreene JamesMGreene deleted the use-configure-pages-v2 branch August 26, 2022 04:33
@TooManyBees
Copy link
Contributor

Should this go to the ghes branch too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pages jekyll publishing workflow results in incorrect baseurl
3 participants