Skip to content

Commit

Permalink
Merge branch 'main' into lefthook
Browse files Browse the repository at this point in the history
  • Loading branch information
bsmth authored Mar 3, 2025
2 parents ec44e98 + ef59ed7 commit 9a49da6
Show file tree
Hide file tree
Showing 1,007 changed files with 12,462 additions and 4,709 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/auto-cleanup-bot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- name: Create PR with only fixable issues
if: success()
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
uses: peter-evans/create-pull-request@dd2324fc52d5d43c699a5636bcf19fceaa70c284 # v7.0.7
with:
commit-message: "chore: auto-fix Markdownlint, Prettier, and front-matter issues"
branch: markdownlint-auto-cleanup
Expand All @@ -54,7 +54,7 @@ jobs:

- name: Create PR with notice on unfixed issues
if: failure()
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
uses: peter-evans/create-pull-request@dd2324fc52d5d43c699a5636bcf19fceaa70c284 # v7.0.7
with:
commit-message: "chore: auto-fix Markdownlint, Prettier, and front-matter issues"
branch: markdownlint-auto-cleanup
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/interfacedata-updater.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
run: node scripts/update-interface-data.js ../webref/

- name: Create pull request
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
uses: peter-evans/create-pull-request@dd2324fc52d5d43c699a5636bcf19fceaa70c284 # v7.0.7
with:
path: mdn-content
token: ${{ secrets.AUTOMERGE_TOKEN }}
Expand Down
30 changes: 30 additions & 0 deletions .github/workflows/pr-review-companion.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,24 @@ on:
types:
- completed

workflow_call:
secrets:
GCP_PROJECT_NAME:
required: true
WIP_PROJECT_ID:
required: true

permissions:
# Download artifact.
actions: read
# Post comment in pull request.
pull-requests: write
# Authenticate with GCP.
id-token: write

jobs:
review:
environment: review
runs-on: ubuntu-latest
if: github.event.workflow_run.conclusion == 'success'
steps:
Expand Down Expand Up @@ -120,3 +130,23 @@ jobs:
--pr-number=$PR_NUMBER \
--diff-file=$BUILD_OUT_ROOT/DIFF \
$BUILD_OUT_ROOT
- name: Authenticate with GCP
if: env.HAS_ARTIFACT
uses: google-github-actions/auth@v2
with:
token_format: access_token
service_account: deploy-mdn-review-content@${{ secrets.GCP_PROJECT_NAME }}.iam.gserviceaccount.com
workload_identity_provider: projects/${{ secrets.WIP_PROJECT_ID }}/locations/global/workloadIdentityPools/github-actions/providers/github-actions

- name: Setup gcloud
if: env.HAS_ARTIFACT
uses: google-github-actions/setup-gcloud@v2

- name: Sync build with GCS
if: env.HAS_ARTIFACT
run: |-
PR_NUMBER=`cat build/NR`
PREFIX="pr$PR_NUMBER"
gsutil -q -m -h "Cache-Control: public, max-age=3600" cp -r build/static "gs://content-review-mdn/$PREFIX/"
gsutil -q -m -h "Cache-Control: public, max-age=3600" rsync -cdrj html,json,txt -y "^static/" build "gs://content-review-mdn/$PREFIX"
27 changes: 17 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MDN Web Docs contribution guide

Thanks for taking the time to contribute to [MDN Web Docs](https://developer.mozilla.org)! :tada:
Thanks for taking the time to contribute to [MDN Web Docs][]! :tada:

This document covers project setup steps along with a set of guidelines for contributing to MDN Web Docs content.
Everyone participating in this project is expected to follow our [Code of Conduct](https://github.com/mdn/content/blob/main/CODE_OF_CONDUCT.md), which means adhering to [Mozilla's Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/).
Expand All @@ -20,7 +20,7 @@ We expect contributors to MDN to have some knowledge of web technologies before
We've put together relevant resources to get up to speed on specific topics before contributing:

- **Open source:** If you're new to open source projects, see the [Open source etiquette][] page.
- **Git and GitHub:** If you are unfamiliar with these, see the section [Getting ready to contribute][] to get pointers on where to start.
- **Git and GitHub:** If you are unfamiliar with these, see the section [What do I need to get started?][] to get pointers on where to start.
- **Web technologies:** HTML, CSS, JavaScript, and more are covered in our [Learn web development][] tutorials.
- **MDN repositories:** To find out where everything lives in various MDN repositories, see our [MDN Web Docs repositories][] page.

Expand Down Expand Up @@ -222,7 +222,7 @@ If you have a [local checkout](#forking-and-cloning-the-repository) of the repos

> [!NOTE]
> Automatically formatting changes does not work for pull requests opened using the GitHub Web UI as described in the ["Simple changes" section](#simple-changes).
> This may result in failed status checks on pull requests. If you're not sure about how to fix this, [get in touch with us][]! for help.
> This may result in failed status checks on pull requests. If you're not sure about how to fix this, [get in touch with us][] for help.
### Adding a new document

Expand Down Expand Up @@ -419,14 +419,21 @@ There are some important rules of etiquette to remember that will help during th
When contributing to the content you agree to license your contributions
according to [our license](LICENSE.md).

<!---
Reference links syntax is used here because of linting markdown files ("fqdn-moz-links" rule).
See https://github.com/mdn/content/pull/21432 and https://github.com/mdn/content/pull/38369.
It can be replaced with the normal links syntax after successfully closing https://github.com/DavidAnson/markdownlint/issues/673.
-->

[mdn web docs]: https://developer.mozilla.org
[getting started with mdn web docs]: https://developer.mozilla.org/en-US/docs/MDN/Community/Getting_started
[community resources]: https://developer.mozilla.org/en-US/docs/MDN/Community
[getting started with mdn web docs]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Getting_started
[getting ready to contribute]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Getting_started#getting_ready_to_contribute
[how to write in markdown]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN
[javascript landing page]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
[learn web development]: https://developer.mozilla.org/en-US/docs/Learn
[writing guidelines]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines
[open source etiquette]: https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette
[mdn web docs repositories]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Our_repositories
[writing style guide]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide
[how to write in markdown]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN
[open source etiquette]: https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette
[what do i need to get started?]: https://developer.mozilla.org/en-US/docs/MDN/Community/Getting_started#what_do_i_need_to_get_started
[learn web development]: https://developer.mozilla.org/en-US/docs/Learn_web_development
[mdn web docs repositories]: https://developer.mozilla.org/en-US/docs/MDN/Community/Our_repositories
[javaScript landing page]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
[get in touch with us]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,11 @@ By participating in and contributing to our projects and discussions, you acknow

You can communicate with the MDN Web Docs team and community using the [communication channels][].

<!---
Reference links syntax is used here because of linting markdown files ("fqdn-moz-links" rule).
See https://github.com/mdn/content/pull/21432 and https://github.com/mdn/content/pull/38369.
It can be replaced with the normal links syntax after successfully closing https://github.com/DavidAnson/markdownlint/issues/673.
-->

[mdn web docs]: https://developer.mozilla.org
[communication channels]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
[MDN Web Docs]: https://developer.mozilla.org/
10 changes: 8 additions & 2 deletions REVIEWING.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,13 @@ for all their help.
- [@vkWeb](https://github.com/vkWeb/)
- [@Ryuno-Ki](https://github.com/Ryuno-Ki)

[get in touch with us]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Getting_started#what_can_i_do_to_help
<!---
Reference links syntax is used here because of linting markdown files ("fqdn-moz-links" rule).
See https://github.com/mdn/content/pull/21432 and https://github.com/mdn/content/pull/38369.
It can be replaced with the normal links syntax after successfully closing https://github.com/DavidAnson/markdownlint/issues/673.
-->

[mdn code example guidelines]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide
[mdn writing style guide]: https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Writing_style_guide
[MDN Web Docs chat rooms]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
[mdn web docs chat rooms]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
[get in touch with us]: https://developer.mozilla.org/en-US/docs/MDN/Community/Getting_started#what_can_i_do_to_help
Loading

0 comments on commit 9a49da6

Please sign in to comment.