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

[OUDS] Change boosted package to ouds-web #2601

Merged
merged 11 commits into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 15 additions & 16 deletions .bundlewatch.config.json
Original file line number Diff line number Diff line change
@@ -1,66 +1,65 @@
{
"files": [
{
"path": "./dist/css/boosted-grid.css",
"path": "./dist/css/ouds-web-grid.css",
"maxSize": "7.0 kB"
},
{
"path": "./dist/css/boosted-grid.min.css",
"path": "./dist/css/ouds-web-grid.min.css",
"maxSize": "6.25 kB"
},
{
"path": "./dist/css/boosted-reboot.css",
"path": "./dist/css/ouds-web-reboot.css",
"maxSize": "4.5 kB"
},
{
"path": "./dist/css/boosted-reboot.min.css",
"path": "./dist/css/ouds-web-reboot.min.css",
"maxSize": "4.5 kB"
},
{
"path": "./dist/css/boosted-utilities.css",
"path": "./dist/css/ouds-web-utilities.css",
"maxSize": "12.75 kB"
},
{
"path": "./dist/css/boosted-utilities.min.css",
"path": "./dist/css/ouds-web-utilities.min.css",
"maxSize": "12.0 kB"
},
{
"path": "./dist/css/boosted.css",
"path": "./dist/css/ouds-web.css",
"maxSize": "44.5 kB"
},
{
"path": "./dist/css/boosted.min.css",
"path": "./dist/css/ouds-web.min.css",
"maxSize": "41.5 kB"
},
{
"path": "./dist/js/boosted.bundle.js",
"path": "./dist/js/ouds-web.bundle.js",
"maxSize": "48.25 kB"
},
{
"path": "./dist/js/boosted.bundle.min.js",
"path": "./dist/js/ouds-web.bundle.min.js",
"maxSize": "25.5 kB"
},
{
"path": "./dist/js/boosted.esm.js",
"path": "./dist/js/ouds-web.esm.js",
"maxSize": "33.25 kB"
},
{
"path": "./dist/js/boosted.esm.min.js",
"path": "./dist/js/ouds-web.esm.min.js",
"maxSize": "20.5 kB"
},
{
"path": "./dist/js/boosted.js",
"path": "./dist/js/ouds-web.js",
"maxSize": "34.0 kB"
},
{
"path": "./dist/js/boosted.min.js",
"path": "./dist/js/ouds-web.min.js",
"maxSize": "18.25 kB"
}
],
"ci": {
"trackBranches": [
"main",
"v4-dev"
"ouds/main"
]
}
}
4 changes: 2 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
# Don't diff or textually merge source maps
*.map binary

boosted.css linguist-vendored=false
boosted.js linguist-vendored=false
ouds-web.css linguist-vendored=false
ouds-web.js linguist-vendored=false
20 changes: 10 additions & 10 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,14 @@ Please adhere to the [coding guidelines](#code-guidelines) used throughout the
project (indentation, accurate comments, etc.) and any other requirements
(such as test coverage).

**Do not edit `boosted.css`, or `boosted.js`and do not commit
**Do not edit `ouds-web.css`, or `ouds-web.js`and do not commit
any dist files (`dist/` or `js/dist`).** Those files are automatically generated by our build tools. You should edit the
source files in [`/boosted/scss/`](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/ouds/main/scss)
and/or [`/boosted/js/src/`](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/ouds/main/js/src) instead.
source files in [`/ouds-web/scss/`](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/ouds/main/scss)
and/or [`/ouds-web/js/src/`](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/ouds/main/js/src) instead.

Similarly, when contributing to Boosted's documentation, you should edit the
documentation source files in
[the `/boosted/site/content/docs/` directory of the `main` branch](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/ouds/main/site/content/docs).
[the `/ouds-web/site/content/docs/` directory of the `ouds/main` branch](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/tree/ouds/main/site/content/docs).
**Do not edit the `gh-pages` branch.** That branch is generated from the
documentation source files and is managed separately by the Boosted Core Team.

Expand All @@ -164,11 +164,11 @@ included in the project:
2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout main
git pull upstream main
git checkout ouds/main
git pull upstream ouds/main
```

3. Create a new topic branch (off the main project development branch) to
3. Create a new topic branch (off the `ouds/main` project development branch) to
contain your feature, change, or fix:

```bash
Expand All @@ -177,14 +177,14 @@ included in the project:

4. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's
or your code is unlikely be merged into the `ouds/main` project. Use Git's
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

```bash
git pull [--rebase] upstream main
git pull [--rebase] upstream ouds/main
```

6. Push your topic branch up to your fork:
Expand All @@ -194,7 +194,7 @@ included in the project:
```

7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/)
with a clear title and description against the `main` branch.
with a clear title and description against the `ouds/main` branch.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the terms of the [MIT License](../LICENSE) (if it
Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ _Note: Please transform `- [ ]` into `- (NA)` in the description when things are
- [ ] Update redirects in docs frontmatter (`site/content/docs/_index.html`?)
- [ ] Move `site/content/docs/5.x` to `site/content/docs/5.x+1`
- [ ] Increment `site/static/docs/{version}` version
- [ ] Increment version in `nuget/boosted.nuspec`
- [ ] (Major version) Manually update the version in `nuget/boosted.nuspec` and `nuget/boosted.sass.nuspec`
- [ ] Increment version in `nuget/ouds-web.nuspec`
- [ ] (Major version) Manually update the version in `nuget/ouds-web.nuspec` and `nuget/ouds-web.sass.nuspec`
- check wrong matches in `CHANGELOG.md`, and maybe `site/content/docs/<version>/migration.md`
- :warning: check the `package-lock.json` and `package.json` content, only "boosted" should have its version changed!
- :warning: check the `package-lock.json` and `package.json` content, only "ouds-web" should have its version changed!
- :warning: `site/content/docs/5.1/**/*.md` should not always be modified
- [ ] if the year changed recently, happy new year :tada: but please change © year in `.scss` main files (reboot, grid, utilities, and main file) as well as in `NOTICE.txt`.
- [ ] `npm run release` to compile dist, build Storybook, update SRI hashes in doc, and package the release
Expand All @@ -117,7 +117,7 @@ _Note: Please transform `- [ ]` into `- (NA)` in the description when things are
- if you're releasing a pre-release, use `--tag`, e.g. for v5-alpha1 `npm publish boosted-5.0.0-alpha1.tgz --tag next`
- (v4 only) `npm publish --tag v4.x.y` (if you forgot and v4 becomes the latest version on NPM, you can run `npm dist-tag add [email protected] latest to fix it)
- (v5 only) `npm publish`
- [ ] check release on [NPM](https://www.npmjs.com/package/boosted), [Nuget](https://www.nuget.org/packages/boosted/), [Packagist](https://packagist.org/packages/orange-opensource/orange-boosted-bootstrap)…
- [ ] check release on [NPM](https://www.npmjs.com/package/ouds-web), [Nuget](https://www.nuget.org/packages/ouds-web/), [Packagist](https://packagist.org/packages/orange-opensource/orange-boosted-bootstrap)…
- [ ] publish documentation on `gh-pages`:
- [ ] copy `../_site` to the `gh-pages` branch (don't forget to update Storybook as well)
- [ ] check every `index.html` used as redirections to redirect to the new release
Expand Down
4 changes: 2 additions & 2 deletions .storybook/preview-head.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<link href="https://cdn.jsdelivr.net" rel="preconnect" crossorigin="anonymous">

<!-- Boosted CSS -->
<link href="https://cdn.jsdelivr.net/npm/boosted/dist/css/boosted.min.css" rel="stylesheet" crossorigin="anonymous">
<link href="https://cdn.jsdelivr.net/npm/ouds-web/dist/css/ouds-web.min.css" rel="stylesheet" crossorigin="anonymous">

<!-- Boosted site CSS -->
<link href="https://boosted.orange.com/docs/5.3/assets/css/docs.css" rel="stylesheet" crossorigin="anonymous">

<!-- Boosted Js: Use of defer because it allows to load only once the bundle (Storybook issue) -->
<script src="https://cdn.jsdelivr.net/npm/boosted/dist/js/boosted.bundle.min.js" crossorigin="anonymous" defer></script>
<script src="https://cdn.jsdelivr.net/npm/ouds-web/dist/js/ouds-web.bundle.min.js" crossorigin="anonymous" defer></script>
2 changes: 1 addition & 1 deletion NOTICE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and reproducing the content of the NOTICE and DOCUMENTATION files.
Any use or displaying shall constitute an infringement under intellectual property laws of France and international conventions.

dist/img/orange-logo.svg
nuget/boosted.png
nuget/ouds-web.png
site/content/docs/**/examples/download-app/img/Banner_image.png
site/content/docs/**/examples/download-app/img/Buttons.png
site/content/docs/**/examples/download-app/img/Buttons_dark.png
Expand Down
116 changes: 58 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,26 @@ Several quick start options are available:

- [Download the latest release](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/archive/v5.3.3.zip)
- Clone the repo: `git clone https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap.git`
- Install with [npm](https://www.npmjs.com/): `npm install boosted@v5.3.3`
- Install with [yarn](https://yarnpkg.com/): `yarn add boosted@v5.3.3`
- Install with [Composer](https://getcomposer.org/): `composer require Orange-OpenSource/Orange-Boosted-Bootstrap:5.3.3`
- Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package boosted` Sass: `Install-Package boosted.sass`
- Install with [npm](https://www.npmjs.com/): `npm install ouds-web@v5.3.3`
- Install with [yarn](https://yarnpkg.com/): `yarn add ouds-web@v5.3.3`
- Install with [Composer](https://getcomposer.org/): `composer require Orange-OpenSource/ouds-web:5.3.3`
- Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package ouds-web` Sass: `Install-Package ouds-web.sass`

Read the [Getting started page](https://boosted.orange.com/docs/getting-started/introduction/) for information on the framework contents, templates, examples, and more.


## Status

[![Build Status](https://img.shields.io/github/actions/workflow/status/Orange-OpenSource/Orange-Boosted-Bootstrap/js.yml?branch=main&label=JS%20Tests&logo=github)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/actions/workflows/js.yml?query=workflow%3AJS+branch%3Amain)
julien-deramond marked this conversation as resolved.
Show resolved Hide resolved
[![npm version](https://img.shields.io/npm/v/boosted?logo=npm&logoColor=fff)](https://www.npmjs.com/package/boosted)
[![npm version](https://img.shields.io/npm/v/ouds-web?logo=npm&logoColor=fff)](https://www.npmjs.com/package/ouds-web)
[![Packagist Prerelease](https://img.shields.io/packagist/v/Orange-Opensource/Orange-Boosted-Bootstrap.svg?include_prereleases&logo=packagist&logoColor=fff)](https://packagist.org/packages/Orange-OpenSource/Orange-Boosted-Bootstrap)
[![NuGet](https://img.shields.io/nuget/vpre/boosted?logo=nuget&logoColor=fff)](https://www.nuget.org/packages/boosted/absoluteLatest)
[![NuGet](https://img.shields.io/nuget/vpre/ouds-web?logo=nuget&logoColor=fff)](https://www.nuget.org/packages/ouds-web/absoluteLatest)
[![Coverage Status](https://img.shields.io/coveralls/github/Orange-OpenSource/Orange-Boosted-Bootstrap/main?logo=coveralls&logoColor=fff)](https://coveralls.io/github/Orange-OpenSource/Orange-Boosted-Bootstrap?branch=main)
[![CSS gzip size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/css/boosted.min.css?compression=gzip&label=CSS%20gzip%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/css/boosted.min.css)
[![CSS Brotli size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/css/boosted.min.css?compression=brotli&label=CSS%20Brotli%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/css/boosted.min.css)
[![JS gzip size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/js/boosted.min.js?compression=gzip&label=JS%20gzip%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/js/boosted.min.js)
[![JS Brotli size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/js/boosted.min.js?compression=brotli&label=JS%20Brotli%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/js/boosted.min.js)
[![JSDelivr](https://data.jsdelivr.com/v1/package/npm/boosted/badge)](https://www.jsdelivr.com/package/npm/boosted)
[![CSS gzip size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/css/ouds-web.min.css?compression=gzip&label=CSS%20gzip%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/css/ouds-web.min.css)
[![CSS Brotli size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/css/ouds-web.min.css?compression=brotli&label=CSS%20Brotli%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/css/ouds-web.min.css)
[![JS gzip size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/js/ouds-web.min.js?compression=gzip&label=JS%20gzip%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/js/ouds-web.min.js)
[![JS Brotli size](https://img.badgesize.io/Orange-OpenSource/Orange-Boosted-Bootstrap/main/dist/js/ouds-web.min.js?compression=brotli&label=JS%20Brotli%20size)](https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/dist/js/ouds-web.min.js)
[![JSDelivr](https://data.jsdelivr.com/v1/package/npm/ouds-web/badge)](https://www.jsdelivr.com/package/npm/ouds-web)

## What's included

Expand All @@ -61,57 +61,57 @@ Within the download you'll find the following directories and files, logically g
<summary>Download contents</summary>

```text
boosted/
ouds-web/
├── css/
│ ├── boosted-grid.css
│ ├── boosted-grid.css.map
│ ├── boosted-grid.min.css
│ ├── boosted-grid.min.css.map
│ ├── boosted-grid.rtl.css
│ ├── boosted-grid.rtl.css.map
│ ├── boosted-grid.rtl.min.css
│ ├── boosted-grid.rtl.min.css.map
│ ├── boosted-reboot.css
│ ├── boosted-reboot.css.map
│ ├── boosted-reboot.min.css
│ ├── boosted-reboot.min.css.map
│ ├── boosted-reboot.rtl.css
│ ├── boosted-reboot.rtl.css.map
│ ├── boosted-reboot.rtl.min.css
│ ├── boosted-reboot.rtl.min.css.map
│ ├── boosted-utilities.css
│ ├── boosted-utilities.css.map
│ ├── boosted-utilities.min.css
│ ├── boosted-utilities.min.css.map
│ ├── boosted-utilities.rtl.css
│ ├── boosted-utilities.rtl.css.map
│ ├── boosted-utilities.rtl.min.css
│ ├── boosted-utilities.rtl.min.css.map
│ ├── boosted.css
│ ├── boosted.css.map
│ ├── boosted.min.css
│ ├── boosted.min.css.map
│ ├── boosted.rtl.css
│ ├── boosted.rtl.css.map
│ ├── boosted.rtl.min.css
│ └── boosted.rtl.min.css.map
│ ├── ouds-web-grid.css
│ ├── ouds-web-grid.css.map
│ ├── ouds-web-grid.min.css
│ ├── ouds-web-grid.min.css.map
│ ├── ouds-web-grid.rtl.css
│ ├── ouds-web-grid.rtl.css.map
│ ├── ouds-web-grid.rtl.min.css
│ ├── ouds-web-grid.rtl.min.css.map
│ ├── ouds-web-reboot.css
│ ├── ouds-web-reboot.css.map
│ ├── ouds-web-reboot.min.css
│ ├── ouds-web-reboot.min.css.map
│ ├── ouds-web-reboot.rtl.css
│ ├── ouds-web-reboot.rtl.css.map
│ ├── ouds-web-reboot.rtl.min.css
│ ├── ouds-web-reboot.rtl.min.css.map
│ ├── ouds-web-utilities.css
│ ├── ouds-web-utilities.css.map
│ ├── ouds-web-utilities.min.css
│ ├── ouds-web-utilities.min.css.map
│ ├── ouds-web-utilities.rtl.css
│ ├── ouds-web-utilities.rtl.css.map
│ ├── ouds-web-utilities.rtl.min.css
│ ├── ouds-web-utilities.rtl.min.css.map
│ ├── ouds-web.css
│ ├── ouds-web.css.map
│ ├── ouds-web.min.css
│ ├── ouds-web.min.css.map
│ ├── ouds-web.rtl.css
│ ├── ouds-web.rtl.css.map
│ ├── ouds-web.rtl.min.css
│ └── ouds-web.rtl.min.css.map
└── js/
├── boosted.bundle.js
├── boosted.bundle.js.map
├── boosted.bundle.min.js
├── boosted.bundle.min.js.map
├── boosted.esm.js
├── boosted.esm.js.map
├── boosted.esm.min.js
├── boosted.esm.min.js.map
├── boosted.js
├── boosted.js.map
├── boosted.min.js
└── boosted.min.js.map
├── ouds-web.bundle.js
├── ouds-web.bundle.js.map
├── ouds-web.bundle.min.js
├── ouds-web.bundle.min.js.map
├── ouds-web.esm.js
├── ouds-web.esm.js.map
├── ouds-web.esm.min.js
├── ouds-web.esm.min.js.map
├── ouds-web.js
├── ouds-web.js.map
├── ouds-web.min.js
└── ouds-web.min.js.map
```
</details>

We provide compiled CSS and JS (`boosted.*`), as well as compiled and minified CSS and JS (`boosted.min.*`). [Source maps](https://web.dev/articles/source-maps) (`boosted.*.map`) are available for use with certain browsers' developer tools. Bundled JS files (`boosted.bundle.js` and minified `boosted.bundle.min.js`) include [Popper](https://popper.js.org/docs/v2/).
We provide compiled CSS and JS (`ouds-web.*`), as well as compiled and minified CSS and JS (`ouds-web.min.*`). [Source maps](https://web.dev/articles/source-maps) (`ouds-web.*.map`) are available for use with certain browsers' developer tools. Bundled JS files (`ouds-web.bundle.js` and minified `ouds-web.bundle.min.js`) include [Popper](https://popper.js.org/docs/v2/).


## Bugs and feature requests
Expand All @@ -129,7 +129,7 @@ Documentation search is powered by [Algolia's DocSearch](https://docsearch.algol

1. Run `npm install` to install the Node.js dependencies, including Hugo (the site builder).
2. Run `npm run test` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root `/boosted` directory, run `npm run docs-serve` in the command line.
3. From the root `/ouds-web` directory, run `npm run docs-serve` in the command line.
4. Open `http://localhost:9001/` in your browser, and voilà.

Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/).
Expand Down
4 changes: 2 additions & 2 deletions build/banner.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ const year = new Date().getFullYear()

function getBanner(pluginFilename) {
return `/*!
* Boosted v${pkg.version} (${pkg.homepage})
* Copyright 2015-${year} The Boosted Authors
* OUDS Web v${pkg.version} (${pkg.homepage})
* Copyright 2015-${year} The OUDS Web Authors
* Copyright 2015-${year} Orange
* Licensed under MIT (https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/ouds/main/LICENSE)
* This a fork of Bootstrap : Initial license below
Expand Down
Loading
Loading