Skip to content

Conversation

@snorremd
Copy link
Contributor

@snorremd snorremd commented Jul 2, 2024

Why:

Fixes regression where the reusable artifact attestations step example was accidentally broken by a commit that replaced dashes with asterisks.

Commit that broke example: 0886a39

What's being changed (if available, include any code snippets, screenshots, or gifs):

Swapped an asterisk in a GitHub actions step example with a dash.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Fixes regression where the reusable artifact attestations step example was accidentally broken by a commit that replaced dashes with asterisks.

Commit that broke example: 0886a39
@welcome
Copy link

welcome bot commented Jul 2, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 2, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Jul 2, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/publishing-packages/publishing-docker-images.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
from reusable

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

It seems linter does not accept dashes in markdown files.
The artiract-attestations-step-for-container-images.md file
only really contains yml, so if we rename it the linter should
accept the dash.
@snorremd
Copy link
Contributor Author

snorremd commented Jul 2, 2024

This seems to be a bit more complicated to solve than I initially thought.

  1. The attestation step reusable file seems to be the only file that contains only YML.
  2. The markdown linter configured for the project will throw a fit if you use a dash -
  3. The templating system does not appear to recognise other extensions than md, so renaming the file to use the yml extension is no good

Not really sure how to solve this, so closing my PR and will add an issue instead so that the core contributors can fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant