Thanks to visit codestin.com
Credit goes to github.com

Skip to content

USWDS-Site: Header - Add changelog entry for megamenu fix. #2111

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

Merged
merged 10 commits into from
Jun 8, 2023
Merged

USWDS-Site: Header - Add changelog entry for megamenu fix. #2111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
70a14cb
Add changelog entry for uswds/uswds#5305
May 30, 2023
7210c3b
Use feature branch
May 31, 2023
37adce5
Update _data/changelogs/component-header.yml
Jun 2, 2023
69bc480
Update _data/changelogs/component-header.yml
Jun 2, 2023
f914a9e
Add flag to header changelog
Jun 2, 2023
04b9616
Update placeholder date
Jun 2, 2023
baba58f
Update changelog README
Jun 2, 2023
1695c33
Get latest feature branch updates
Jun 5, 2023
7d22d09
Merge branch 'dw-changelog-button-outline-whc' into jm-extended-megam…
thisisdano Jun 6, 2023
105893e
Merge branch 'dw-changelog-button-outline-whc' into jm-extended-megam…
thisisdano Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions _data/changelogs/_CHANGELOG-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Creating changelogs

## Available data keys
| Key | Description | Optional | Value type | Standard values | Displayed |
| :--- | :----------- | -------- | ---------- | --------------- | --------- |
| title | Page title | yes | string| N/A | No |
| type | Identify page type| no | string| component, documentation, pattern, template, token, utility | No |
| changelogURL | url for CHANGELOG.MD | yes | string| N/A | yes |
| date | Merge date (YYYY-MM-DD)| no | date | N/A | yes |
| summary | Short description of change | no | string| N/A | yes |
| summaryAdditional | Additional description | yes | string| N/A | yes |
| isBreaking | Breaking change | no | boolean | true, false | yes |
| affectsAccessibility | Change affects accessibility| yes | boolean | true, false | yes |
| affectsMarkup | Change affects component markup | yes | boolean | true, false | yes |
| affectsJavascript | Change affects component JS | yes | boolean | true, false | yes |
| affectsStyles | Change affects component styles, appearance, or settings | yes | boolean | true, false | yes |
| affectsContent | Change affects content in the component itself | yes | boolean | true, false | yes |
| affectsGuidance | Change affects component guidance| yes | boolean | true, false | yes |
| affectsAssets | Change affects assets related to a component, like images | yes | boolean | true, false | yes |
| affectsSettings | Change affects settings | yes | boolean | true, false | yes |
| githubPr | Pull request number | no | number| N/A | yes |
| githubRepo | Pull request repo name | no | string| uswds, uswds-site | yes |
| versionUswds | USWDS Version Number | no | number| N/A | yes |
| Key | Description | Optional | Value type | Standard values | Displayed |
| :------------------- | :--------------------------------------------------------- | -------- | ---------- | ----------------------------------------------------------- | --------- |
| title | Page title | yes | string | N/A | No |
| type | Identify page type | no | string | component, documentation, pattern, template, token, utility | No |
| changelogURL | url for CHANGELOG.MD | yes | string | N/A | yes |
| date | Merge date (YYYY-MM-DD). Use `NNNN-NN-NN` for placeholder. | no | date | N/A | yes |
| summary | Short description of change | no | string | N/A | yes |
| summaryAdditional | Additional description | yes | string | N/A | yes |
| isBreaking | Breaking change | no | boolean | true, false | yes |
| affectsAccessibility | Change affects accessibility | yes | boolean | true, false | yes |
| affectsMarkup | Change affects component markup | yes | boolean | true, false | yes |
| affectsJavascript | Change affects component JS | yes | boolean | true, false | yes |
| affectsStyles | Change affects component styles, appearance, or settings | yes | boolean | true, false | yes |
| affectsContent | Change affects content in the component itself | yes | boolean | true, false | yes |
| affectsGuidance | Change affects component guidance | yes | boolean | true, false | yes |
| affectsAssets | Change affects assets related to a component, like images | yes | boolean | true, false | yes |
| affectsSettings | Change affects settings | yes | boolean | true, false | yes |
| githubPr | Pull request number | no | number | N/A | yes |
| githubRepo | Pull request repo name | no | string | uswds, uswds-site | yes |
| versionUswds | USWDS Version Number | no | number | N/A | yes |

## Using .yml files
- Tab spacing matters. Incorrect spacing can cause errors, so make sure your items line up.
Expand All @@ -47,7 +47,7 @@ title:
type:
changelogURL:
items:
- date:
- date: NNNN-NN-NN
summary:
summaryAdditional:
isBreaking:
Expand Down
14 changes: 12 additions & 2 deletions _data/changelogs/component-header.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@ title: Header
type: component
changelogURL:
items:
- date: NNNN-NN-NN
summary: Fixed a bug that caused inaccurate megamenu template markup in the documentation.
summaryAdditional: The markup in megamenu code examples now accurately includes the `usa-megamenu` class.
isBreaking: false
affectsGuidance: true
affectsMarkup: true
githubPr: 5311
githubRepo: uswds
versionUswds: 3.5.0
- date: NNNN-NN-NN
summary: Removed the `id` attribute from the `usa-logo` element.
summaryAdditional:
Expand All @@ -12,7 +21,8 @@ items:
versionUswds: 3.5.0
- date: 2023-03-13
summary: Extended headers now respect the value passed to `$theme-header-logo-text-width`.
summaryAdditional: For extended headers, the default setting value is narrower than
summaryAdditional:
For extended headers, the default setting value is narrower than
the previous hard-coded value, which can cause unexpected line breaks for `usa-logo__text`.
isBreaking: true
affectsStyles: true
Expand Down Expand Up @@ -97,7 +107,7 @@ items:
githubRepo: uswds
versionUswds: 2.13.0
- date: 2021-12-14
summary: Improved resilience of icon-only functionality in search.
summary: Improved resilience of icon-only functionality in search.
summaryAdditional: Updated search to add a text equivalent if the image path is broken and does not load.
isBreaking: true
affectsAccessibility: true
Expand Down