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.

Sign up for GitHub

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

Jump to bottom

Fix regression in artifact-attestations-step-for-container-images.md #33917

Merged
merged 8 commits into from
Jul 18, 2024
Merged

Fix regression in artifact-attestations-step-for-container-images.md #33917

merged 8 commits into from
Jul 18, 2024

Conversation

janbrasna
Copy link
Contributor

@janbrasna janbrasna commented Jul 10, 2024 •
edited
Loading

This is another approach to #33793

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 #33794
@janbrasna @snorremd
Fix regression in artifact-attestations-step-for-container-images.md
2a7fac6 
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

Co-authored-by: snorremd <snorremd@users.noreply.github.com>
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 10, 2024
@janbrasna janbrasna closed this Jul 10, 2024
@janbrasna janbrasna deleted the fix/md-yml-lint branch July 10, 2024 11:43
@janbrasna

This comment was marked as resolved.

Sign in to view
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 10, 2024 •
edited
Loading

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
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10
packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10
from reusable

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
@janbrasna janbrasna restored the fix/md-yml-lint branch July 10, 2024 14:08
@janbrasna janbrasna reopened this Jul 10, 2024
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jul 10, 2024
@subatoi
Copy link
Contributor

subatoi commented Jul 11, 2024

Hi @janbrasna—in hindsight, I think a better solution would probably be to just make these not-reusables, as there's only three instances of it anyway. I'm sorry for misleading you.

Let me run it by our Engineering team to see what they think—when we open a PR to fix it, whatever the fix looks like, I'll make sure you're added as co-contributor so you receive the credit, if that sounds OK?
@janbrasna
Copy link
Contributor Author

@subatoi Sure, whatever feels more stable for now. I've updated this PR to getting rid of the reusable (which is not a bad idea after all, as it is probably the only occurrence where bits of code are placed in toplevel markdown file without any guardrails around defining what formatting/markup it's supposed be written in, a footgun in itself…)

Please don't bother with credits et al., I only wanted to get this moving — whatever path you end up picking feel free to just close this out, no worries;)
@Disastrous-young-411

This comment was marked as spam.

Sign in to view
2 similar comments
@Disastrous-young-411

This comment was marked as spam.

Sign in to view
@Disastrous-young-411

This comment was marked as spam.

Sign in to view
SiaraMist
SiaraMist approved these changes Jul 18, 2024
View reviewed changes
Copy link
Contributor

@SiaraMist SiaraMist left a comment

Choose a reason for hiding this comment

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

Thanks for catching this and working with us to fix it, @janbrasna! I think the workaround you added looks good, so I'll go ahead and get this merged.
@SiaraMist SiaraMist enabled auto-merge July 18, 2024 18:18
@SiaraMist SiaraMist added this pull request to the merge queue Jul 18, 2024
Merged via the queue into github:main with commit 5381272 Jul 18, 2024
44 checks passed
@github-actions GitHub Actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡
@janbrasna janbrasna deleted the fix/md-yml-lint branch July 18, 2024 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
5 participants
@janbrasna @subatoi @Disastrous-young-411 @SiaraMist @nguyenalex836