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

Prepare release v5.0.0 #670

Merged
merged 19 commits into from
May 27, 2021
Merged

Prepare release v5.0.0 #670

merged 19 commits into from
May 27, 2021

Conversation

klediouron
Copy link
Contributor

@klediouron klediouron commented May 21, 2021

chore(merge main): patched commit → bf09367

  • Run linters;
  • Run compilers;
  • Run tests;
  • Check documentation site: examples and contents;
  • Test cross-browser compatibility locally and with BrowserStack:
    • Firefox ESR
    • IE11 (v4 only)
    • Latest Edge, Chrome, Firefox, Safari
    • iOS Safari
    • Chrome & Firefox on Android
  • Including RTL mode;
  • Ask for reviews and accessibility testing;
  • sync with Bootstrap's release and probably wait for it;
  • npm run release-version $current_version $next_version to bump version number
    • if bumping a minor or major version:
      • Manually change version_short in package.json
      • Add docs version to _data/docs-versions.yml
      • Manually change docs_version in _config.yml
      • Update redirects in docs frontmatter
      • Move docs to the new docs' subfolder?
      • Ensure Algolia indexes new release content (probably requires a PR)
    • check wrong matches in CHANGELOG.md, and maybe site/content/docs/<version>/migration.md
  • npm run release to compile dist, update SRI hashes in doc and package the release
  • Prepare changelog:
  • commit and push dist with a chore(release) commit message
  • merge (on v5-dev for now)
  • tag your version, and push your tag
  • create a GitHub release:
    • attach zip file
    • paste CHANGELOG / Ship list in the release's description
  • publish documentation on gh-pages:
    • copy ../bs-docs to the gh-pages branch
    • check every index.html used as redirections to be redirecting to the new release
    • when bumping minor version: ensure dist URLs in examples' HTML has changed
    • double-check everything before pushing, starting by searching for forgotten old version number occurences
  • npm pack then npm publish
  • publish on Nuget
  • check release on NPM, Nuget, Packagist
  • make an announcement in Plazza 🎉

@klediouron
Copy link
Contributor Author

Opened a PR for DocSearch config

Copy link
Contributor

@ffoodd ffoodd left a comment

Choose a reason for hiding this comment

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

Seems very good to me, only a few tweaks here and there 👌

CHANGELOG.md Outdated Show resolved Hide resolved
config.yml Outdated Show resolved Hide resolved
scss/forms/_form-control.scss Outdated Show resolved Hide resolved
site/content/docs/5.0/components/alerts.md Outdated Show resolved Hide resolved
site/data/core-team.yml Show resolved Hide resolved
Copy link
Contributor

@ffoodd ffoodd left a comment

Choose a reason for hiding this comment

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

Well done, keep going with DoD 😉

@@ -7,7 +7,7 @@
---

<svg xmlns="http://www.w3.org/2000/svg">
<symbol id="bootstrap" viewBox="0 0 118 94">
<symbol id="bootstrap" viewBox="0 0 118 94" style="display:none">
Copy link
Contributor

Choose a reason for hiding this comment

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

Why only hide it? Couldn't you replace SVG content with Orange's logo?
Didn't check at all where this is used, BTW :')

Copy link
Member

Choose a reason for hiding this comment

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

display none move to svg itself

@@ -6,64 +6,6 @@
body_class: ""
---

<svg xmlns="http://www.w3.org/2000/svg">
Copy link
Contributor

Choose a reason for hiding this comment

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

Hum so you did remove them. However they're probably called somewhere with the <use> tag and symbols' id, aren't they?

Copy link
Member

Choose a reason for hiding this comment

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

yes ;-)

@@ -117,7 +117,7 @@ $background-colors: map-merge(
"success": $supporting-green,
"info": $supporting-blue,
"warning": $supporting-yellow,
"danger": $purple
"danger": $danger
Copy link
Contributor

Choose a reason for hiding this comment

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

Going this way, you should probably use functional colors above too instead of supporting ones, isn't it?
Or does inconsistency acceptable here?

Definitely a topic to address wth the brand team, giving a red supporting color instead of the functional one, IMHO.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Created an issue to keep track of this

@@ -83,5 +83,5 @@ params:
js_bundle_hash: "sha384-3pZoGeuGuppkOcTDkPFSq3eCeByOZjj3CQ2PRI7hTL8gCUSPno1ZKZo2yeta2U1D"
popper: "https://cdn.jsdelivr.net/npm/@popperjs/core@2.9.1/dist/umd/popper.min.js"
popper_hash: "sha384-SR1sx49pcuLnqZUnnPwx6FCym0wLsk5JZuNx2bPPENzswTNFaQU1RDvt3wT4gWFG"
focus_visible: "https://cdn.jsdelivr.net/npm/focus-visible@5.1.0/dist/focus-visible.min.js"
focus_visible: "https://cdn.jsdelivr.net/npm/focus-visible@5.2.0/dist/focus-visible.min.js"
Copy link
Contributor

Choose a reason for hiding this comment

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

If docs are using bundled JS, why do we use this? In "Getting Started" docs, maybe?

Copy link
Member

Choose a reason for hiding this comment

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

Yes you're the author of the callout in introduction. In case project don't use boosted JS

{{< callout warning >}}
#### Required script

Boosted includes [WICG's `:focus-visible` polyfill](https://github.com/WICG/focus-visible) to ensure an enhanced focus visibility for keyboard users while shutting down focus styles on active state.
However, if you don't need or want to use Boosted's JavaScript files, you'll still need to use the polyfill.
```html
<script src="{{< param "cdn.focus_visible" >}}" integrity="{{< param "cdn.focus_visible_hash" >}}" crossorigin="anonymous"></script>

{{< /callout >}}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is used in Getting Started docs indeed:

<script src="{{< param "cdn.focus_visible" >}}" integrity="{{< param "cdn.focus_visible_hash" >}}" crossorigin="anonymous"></script>```

@Lausselloic Lausselloic merged commit c47934b into v5-dev May 27, 2021
@Lausselloic Lausselloic deleted the chore/merge-main@bf09367 branch May 27, 2021 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants