Docs fixes

- Fix a few typos
- Remove mention of LGTM (service closed)
- Update Theme Color docs
- Fix a markdown link
- Remove unnecessary 'Table of Contents' from FAQ since we only have 2 questions
- Rename GitHub Action file extensions from .yaml to .yml for consistency
- Run Prettier
- Fix typo on CHANGELOG
This commit is contained in:
coliff
2023-12-05 18:07:59 +09:00
parent 2789ddbfee
commit e0689d1e8f
8 changed files with 24 additions and 34 deletions

View File

@@ -165,7 +165,7 @@ included in the project:
```
10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description.
with a clear title and description.
**IMPORTANT**: By submitting a patch, you agree to allow the project
owners to license your work under the terms of the [MIT License](LICENSE.txt).

View File

@@ -3,7 +3,7 @@ name: publish
on:
push:
tags:
- 'v*'
- "v*"
permissions:
contents: read
@@ -11,7 +11,7 @@ permissions:
jobs:
build:
permissions:
contents: write # for actions/create-release to create a release
contents: write # for actions/create-release to create a release
name: Upload Release Asset
runs-on: ubuntu-latest
steps:

View File

@@ -2,7 +2,7 @@ name: Push to template repository
on:
push:
branches: [ main ]
branches: [main]
permissions:
contents: read
@@ -25,20 +25,19 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 'lts/*'
node-version: "lts/*"
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
run: npm run build
- name: Pushes to another repository
uses: cpina/github-action-push-to-another-repository@main
env:
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
with:
source-directory: 'dist'
destination-github-username: 'h5bp'
destination-repository-name: 'html5-boilerplate-template'
user-name: 'roblarsen'
source-directory: "dist"
destination-github-username: "h5bp"
destination-repository-name: "html5-boilerplate-template"
user-name: "roblarsen"
user-email: rob@htmlcssjavascript.com
commit-message: "The latest and greatest from HTML5 Boilerplate"

View File

@@ -12,13 +12,13 @@
- Farewell Internet Explorer! [#2773](https://github.com/h5bp/html5-boilerplate/issues/2773)
- Remove apache-server-configs/.htaccess [#2779](https://github.com/h5bp/html5-boilerplate/pull/2779)
- Moving docs out of src and dist [#2655](https://github.com/h5bp/html5-boilerplate/pull/2655)
- Replace Parcel with Webpack [#2641](https://github.com/h5bp/html5-boilerplate/pull/2641)
- Add SVG Favicon [#2554](https://github.com/h5bp/html5-boilerplate/issues/2554)
- Remove Google Analytics [#2547](https://github.com/h5bp/html5-boilerplate/issues/2547)
- Replace Parcel with Webpack [#2641](https://github.com/h5bp/html5-boilerplate/pull/2641)
- Add SVG Favicon [#2554](https://github.com/h5bp/html5-boilerplate/issues/2554)
- Remove Google Analytics [#2547](https://github.com/h5bp/html5-boilerplate/issues/2547)
- Rename master branch to main [#2583](https://github.com/h5bp/html5-boilerplate/issues/2583)
- Remove humans.txt [#2584](https://github.com/h5bp/html5-boilerplate/pull/2584)
- Add a templte repository [#2391](https://github.com/h5bp/html5-boilerplate/pull/2391)
- Remove plugins js [#2346](https://github.com/h5bp/html5-boilerplate/pull/2346)
- Add a template repository [#2391](https://github.com/h5bp/html5-boilerplate/pull/2391)
- Remove plugins js [#2346](https://github.com/h5bp/html5-boilerplate/pull/2346)
- Rename CSS file [#2342](https://github.com/h5bp/html5-boilerplate/pull/2342) and JS file [#2341](https://github.com/h5bp/html5-boilerplate/pull/2341)
## 8.0.0 (June 04, 2020)

View File

@@ -1,7 +1,7 @@
# About This Repo
This document outlines the configuration of this repo as well as the basic
process we use to manage the project. As Github has matured as a platform
process we use to manage the project. As GitHub has matured as a platform
and HTML5 Boilerplate has matured as a project there are a lot of lessons
to be learned from the way we run the show here.
@@ -68,9 +68,7 @@ Our branch protection rules are as follows:
- We run a _dependency review_ scan to see if any newly added dependencies add
known security flaws. This is important for even us, but for a project that
uses a larger number of third party dependencies, this sort of check is vital.
- Since we're fan of the "belt and suspenders" approach to security, we also
run a _LGTM.com_ scan as well as the CodeQL scans. This tool, built on top of
CodeQl can shake out different issues so it's nice to have the pair.
- We also run a CodeQL scans to check for security issues and problems.
- We push any changes to `main` to our [HTML5\-Boilerplate Template Repo](https://github.com/h5bp/html5-boilerplate-template)
Since we've talked about some of our Actions, let's look at the full configuration
@@ -79,7 +77,7 @@ of our `.github` folder.
### .github Folder
- workflows
- `build-dist.yaml` is currently broken. We can't push to `main` without a
- `build-dist.yml` is currently broken. We can't push to `main` without a
code review, so this task is blocked. What I would like, (are you there,
GitHub, it's me, Rob) is to allow Actions to bypass branch protection
rules. I think we'll have to basically write a mini-bot that opens a PR
@@ -87,17 +85,17 @@ of our `.github` folder.
until the PR is closed. In some ways that will be better as it will be less
noisy in terms of bot pushes to main.
- `codeql-analysis.yml` controls our CodeQL action. We use the defaults. If
you're building something with more JAvaScript footprint, you can tweak
you're building something with more JavaScript footprint, you can tweak
the settings for this job.
- `dependency-review.yml` does what it says on the tin- it tests newly
introduced dependencies for vulnerabilities.
- `publish.yaml` is the action that publishes all the various versions of
- `publish.yml` is the action that publishes all the various versions of
the project. When we create a new tag and push it to GitHub, this script
publishes our npm package and creates a GitHub release and attaches a zip
file of our `dist` folder.
- `push-to-template.yaml` pushes the `HEAD` of `main` to our template repo
- `push-to-template.yml` pushes the `HEAD` of `main` to our template repo
- `spellcheck.yml` automatically checks markdown files for typos with cSpell.
- `test.yaml` runs our test suite.
- `test.yml` runs our test suite.
- `CODE_OF_CONDUCT.md` is our Code of Conduct, based on
[Contributor Covenant.](https://www.contributor-covenant.org/)
- `CONTRIBUTING.md` contains our contribution guidelines.

View File

@@ -16,7 +16,7 @@ everything fits with everyone's needs.
- [Social Networks](#social-networks)
- [URLs](#urls)
- [Web Apps](#web-apps)
- [security.txt](#security.txt)
- [security.txt](#securitytxt)
## Server Configuration
@@ -339,9 +339,7 @@ colors.
The `content` attribute extension can take any valid CSS color.
Currently, the `theme-color` meta extension is supported by [Chrome 39+ for
Android
Lollipop](https://developers.google.com/web/updates/2014/11/Support-for-theme-color-in-Chrome-39-for-Android).
For browser support details, refer to [Can I Use](https://caniuse.com/meta-theme-color).
### security.txt

View File

@@ -3,11 +3,6 @@ table of contents](TOC.md)
# Frequently asked questions
- [Do I need to upgrade my site each time a new version of HTML5 Boilerplate is
released?](#do-i-need-to-upgrade-my-site-each-time-a-new-version-of-html5-boilerplate-is-released)
- [Where can I get help with support
questions?](#where-can-i-get-help-with-support-questions)
## Do I need to upgrade my site each time a new version of HTML5 Boilerplate is released?
No, just as you don't normally replace the foundation of a house once it was