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.

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

USWDS-Site: Documentation updates for 3.11.0 #2991

Merged
merged 47 commits into from
Dec 19, 2024
Merged

USWDS-Site: Documentation updates for 3.11.0 #2991

merged 47 commits into from
Dec 19, 2024

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Nov 25, 2024

Summary

  • Updated uswds_version and the package hash url in config.yml to point to 3.11.0.
  • Added changelogs for 3.11.0
  • Added other documentation updates for 3.11.0

Tasks before merge

  • Update the uswds version to 3.11.0 in the package.json
  • Replace references to NNNN-NN-NN with the release date
  • Replace references to N.N.N with 3.11.0

Related issue

Closes #2990

Preview link

3.11.0 updates that do not require a changelog

Testing and review

  • Confirm all release items are accounted for in the PR description
  • Confirm that the "Download" button in the header shows the new version number
  • Confirm all changelogs are present
  • Confirm that each changelog:
    • Follows the standard changelog format (written in past tense, have a period, etc). More details on format can be found in the changelog README file.
    • Points to the correct USWDS PR.
    • Makes sense.
    • Has no spelling or grammatical errors.
    • Has the correct “type” tags
    • Has the correct date and release version.
  • Confirm no regressions after installing the release updates in develop
  • Confirm all release markup changes have been incorporated into the components we use on site (if applicable)
  • Confirm that setting and variant updates in USWDS are updated on site (if applicable)
  • Confirm that the component guidance is updated as needed (if applicable)
  • On the download page, confirm:
  • The version number is correct
  • The listed SHA-256 hash matches the release hash
  • Confirm that the package.json uses the new USWDS version

@amyleadem amyleadem changed the title Update 3.10.0 -> 3.11.0 in config.yml USWDS-Site: Documentation updates for 3.11.0 Dec 2, 2024
USWDS-Site: Add changelog for footer outline fix [#6237]
USWDS-Site - Changelog:  Enhance file input error callouts[#6168]
USWDS-Site: Add changelog for input widths [#6232]
USWDS-Site - Changelog: Add styling to table headers [#5986]
@amyleadem amyleadem marked this pull request as ready for review December 17, 2024 16:35
@amyleadem amyleadem requested a review from a team as a code owner December 17, 2024 16:35
package.json Outdated
@@ -97,6 +97,6 @@
"snyk": true,
"dependencies": {
"@uswds/compile": "1.2.0",
"@uswds/uswds": "3.10.0"
"@uswds/uswds": "github:uswds/uswds#develop"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note

This was installed to test the release on site. We will need to update this to 3.11.0 before merge.

Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Two potential changes, let me know what you think!

_data/changelogs/component-input-prefix-suffix.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@mejiaj mejiaj left a comment

Choose a reason for hiding this comment

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

Previews look good.

I added a few comments to help quickly update the dates. As well as minor suggestions for clarity and one issue with indents in Modal YML.

_data/changelogs/component-collection.yml Outdated Show resolved Hide resolved
_data/changelogs/component-collection.yml Outdated Show resolved Hide resolved
_data/changelogs/component-file-input.yml Outdated Show resolved Hide resolved
_data/changelogs/component-file-input.yml Outdated Show resolved Hide resolved
_data/changelogs/component-footer.yml Outdated Show resolved Hide resolved
_data/changelogs/component-modal.yml Outdated Show resolved Hide resolved
_data/changelogs/component-modal.yml Show resolved Hide resolved
_data/changelogs/component-pagination.yml Outdated Show resolved Hide resolved
_data/changelogs/component-table.yml Outdated Show resolved Hide resolved
_data/changelogs/component-text-input.yml Outdated Show resolved Hide resolved
mahoneycm
mahoneycm previously approved these changes Dec 18, 2024
Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks Amy

@thisisdano thisisdano merged commit 03f0b86 into main Dec 19, 2024
11 checks passed
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.

USWDS-Site: Update documentation site for 3.11.0
6 participants