Skip to content

Conversation

steiza
Copy link
Contributor

@steiza steiza commented Oct 7, 2025

Pre-requisites

  • Prior to submitting a new workflow, please apply to join the GitHub Technology Partner Program: partner.github.com/apply.

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 privileged 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.
    • creator: Name of the organization/user 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.

@steiza steiza requested review from Copilot and removed request for Copilot October 7, 2025 18:53
@steiza steiza requested review from a team as code owners October 7, 2025 18:53
@steiza
Copy link
Contributor Author

steiza commented Oct 7, 2025

- run: npm ci
# It is recommend to publish to npm using trusted publishing; for details,
# see: https://docs.npmjs.com/trusted-publishers
- run: npm publish
Copy link
Contributor

@hashtagchris hashtagchris Oct 9, 2025

Choose a reason for hiding this comment

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

We may want to leave the token commented out, as a fallback for GHES, and GHEC w/ data residency.

Suggested change
- run: npm publish
- run: npm publish
env:
# An explicit token is needed only for non-github.com workflows.
# NODE_AUTH_TOKEN: ${{secrets.npm_token}}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think a bare env: will cause an error, but I pushed up a riff on this suggestion.

@Copilot Copilot AI review requested due to automatic review settings October 9, 2025 12:01
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the npm-publish.yml starter workflow to use npm's trusted publishing feature instead of requiring manual token management. This change improves security by eliminating the need to store and manage npm access tokens as secrets.

  • Adds required id-token: write permission for trusted publishing
  • Updates npm to ensure compatibility with trusted publishing (requires npm 11.5.1+)
  • Removes the env block that used manual tokens and adds commented fallback instructions

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

- name: Update npm
run: npm install -g npm@latest
- run: npm ci
# It is recommend to publish to npm using trusted publishing; for details,
Copy link

Copilot AI Oct 9, 2025

Choose a reason for hiding this comment

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

Corrected grammar from 'It is recommend' to 'It is recommended'.

Suggested change
# It is recommend to publish to npm using trusted publishing; for details,
# It is recommended to publish to npm using trusted publishing; for details,

Copilot uses AI. Check for mistakes.

Copy link
Contributor

@hashtagchris hashtagchris left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@thboop thboop left a comment

Choose a reason for hiding this comment

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

lgtm

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.

3 participants