Skip to content

Conversation

@ddbeck
Copy link
Collaborator

@ddbeck ddbeck commented Aug 23, 2024

I just did a web-features release and made a few improvements to the publishing docs as I went. Hopefully this stuff will help me complete it a little faster next time:

  • Explain where we're checking for unescaped HTML
  • Provide Markdown literals for pasting into the release description
  • Add follow up step for "version required" labels
  • Add a regex hint for creating releases
  • Use full stops consistently
  • Number the steps

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 23, 2024
Copy link
Collaborator

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

Thanks Daniel! Maybe someone other than you should at release the package to see if the docs are useful enough. This reads good to me, though!

@Elchi3 Elchi3 merged commit 3af374d into web-platform-dx:main Sep 5, 2024
@ddbeck ddbeck deleted the publishing-docs-improvements branch September 5, 2024 12:58
@ddbeck
Copy link
Collaborator Author

ddbeck commented Sep 5, 2024

Yes, I agree that would be good to do—though I have some more changes to follow up to this. Luckily, Philip wrote the original text and I learned to release from it, so the foundations are solid.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants