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

chore: Use build hook for docs deploy #15945

Merged
merged 2 commits into from Jun 1, 2022
Merged

chore: Use build hook for docs deploy #15945

merged 2 commits into from Jun 1, 2022

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented May 30, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:

Workflow change

What changes did you make? (Give an overview)

I switched the docs deploy workflow to use a Netlify build hook instead of building the website locally. I verified that this will trigger a full build and deploy to production.

Is there anything you'd like reviewers to focus on?

Please double-check that this will work correctly. :)

@eslint-github-bot eslint-github-bot bot added chore This change is not user-facing triage An ESLint team member will look at this issue soon labels May 30, 2022
@netlify
Copy link

netlify bot commented May 30, 2022

Deploy Preview for docs-eslint canceled.

Name Link
🔨 Latest commit fb4eca8
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62956d08963795000848867f

@mdjermanovic
Copy link
Member

I switched the docs deploy workflow to use a Netlify build hook instead of building the website locally. I verified that this will trigger a full build and deploy to production.

I can see two deploys triggered by hook, but the version on the site is still 8.15.0:

https://new.eslint.org/docs

@mdjermanovic
Copy link
Member

Probably because publishing is locked to a deploy that was on May 19.

@nzakas
Copy link
Member Author

nzakas commented May 31, 2022

Welp, it appears I was once again confused by the Netlify terminology. So it was deployed but not published. I guess we do need to manually build in order to publish. I don’t see any additional options with build hooks.

@mdjermanovic
Copy link
Member

Is the problem that we have locked the publishing, or that build hooks cannot publish at all?

@nzakas
Copy link
Member Author

nzakas commented May 31, 2022

It's that auto-publishing is turned off. As best I can tell:

  • build - means building the artifact
  • deploy - means deployed to a test environment
  • publish - means deployed to the production environment

So build hooks will build and deploy but not publish unless auto-publishing is on.

Let's try adding --prod to the current script and see if that gets us where we want to be.

@mdjermanovic
Copy link
Member

Maybe we could set up the site to auto-build/deploy/publish from another branch on every update of that branch, and force-update that branch on releases. That would also allow for fixing critical UI bugs directly on the published site between releases without changing the content.

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

This change LGTM, assuming that "production deploy" means publishing.

@nzakas
Copy link
Member Author

nzakas commented Jun 1, 2022

Maybe we could set up the site to auto-build/deploy/publish from another branch on every update of that branch, and force-update that branch on releases.

That was where I started, too. I just wasn’t sure if we wanted to add another step to the release process. Let’s see if this PR works and we can always add another branch later.

@nzakas nzakas merged commit f836743 into main Jun 1, 2022
@nzakas nzakas deleted the docs-deploy-hook branch June 1, 2022 00:20
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Jun 17, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.16.0` -> `8.17.0`](https://renovatebot.com/diffs/npm/eslint/8.16.0/8.17.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.17.0`](https://github.com/eslint/eslint/releases/tag/v8.17.0)

[Compare Source](eslint/eslint@v8.16.0...v8.17.0)

#### Features

-   [`55319e1`](eslint/eslint@55319e1) feat: fix indent bug with semicolon-first style ([#&#8203;15951](eslint/eslint#15951)) (Milos Djermanovic)
-   [`f6d7920`](eslint/eslint@f6d7920) feat: add `allowNamedExports` option to no-use-before-define ([#&#8203;15953](eslint/eslint#15953)) (Milos Djermanovic)

#### Bug Fixes

-   [`54c0953`](eslint/eslint@54c0953) fix: cleanup typos ([#&#8203;15939](eslint/eslint#15939)) (Nick Schonning)
-   [`845a7af`](eslint/eslint@845a7af) fix: typo ocatal -> octal ([#&#8203;15940](eslint/eslint#15940)) (Nick Schonning)

#### Documentation

-   [`b915018`](eslint/eslint@b915018) docs: Update website UI to latest ([#&#8203;15944](eslint/eslint#15944)) (Nicholas C. Zakas)
-   [`f0bb609`](eslint/eslint@f0bb609) docs: Update Exponentiation operator MDN link ([#&#8203;15960](eslint/eslint#15960)) (Pranjal Jain)
-   [`baa0153`](eslint/eslint@baa0153) docs: Use correct past tense "left" instead of "leaved" ([#&#8203;15950](eslint/eslint#15950)) (Frederik Braun)
-   [`1351a9b`](eslint/eslint@1351a9b) docs: Add Resources section to rule pages ([#&#8203;15901](eslint/eslint#15901)) (Nicholas C. Zakas)
-   [`68cf0fb`](eslint/eslint@68cf0fb) docs: cleanup typos ([#&#8203;15936](eslint/eslint#15936)) (Nick Schonning)
-   [`13b62ae`](eslint/eslint@13b62ae) docs: use-dart-sass instead of node-sass ([#&#8203;15912](eslint/eslint#15912)) (Deepshika S)
-   [`c81c5d6`](eslint/eslint@c81c5d6) docs: add social media links ([#&#8203;15920](eslint/eslint#15920)) (Deepshika S)
-   [`0d6a50b`](eslint/eslint@0d6a50b) docs: fix openjs link ([#&#8203;15917](eslint/eslint#15917)) (Amaresh  S M)
-   [`54910f5`](eslint/eslint@54910f5) docs: display version in mobile view ([#&#8203;15909](eslint/eslint#15909)) (Amaresh  S M)

#### Chores

-   [`da694b9`](eslint/eslint@da694b9) chore: avoid theme flashes ([#&#8203;15927](eslint/eslint#15927)) (Strek)
-   [`f836743`](eslint/eslint@f836743) chore: Use build hook for docs deploy ([#&#8203;15945](eslint/eslint#15945)) (Nicholas C. Zakas)
-   [`ce035e5`](eslint/eslint@ce035e5) test: cleanup typos ([#&#8203;15937](eslint/eslint#15937)) (Nick Schonning)
-   [`10249ad`](eslint/eslint@10249ad) chore: use addEventListener instead of addListener ([#&#8203;15923](eslint/eslint#15923)) (Amaresh  S M)
-   [`5f5c1fb`](eslint/eslint@5f5c1fb) chore: lint eleventy config file ([#&#8203;15904](eslint/eslint#15904)) (Milos Djermanovic)
-   [`8513d37`](eslint/eslint@8513d37) chore: update Rule typedefs ([#&#8203;15915](eslint/eslint#15915)) (Milos Djermanovic)
-   [`55534f1`](eslint/eslint@55534f1) test: ensure no-restricted-imports works with NodeJS imports ([#&#8203;15907](eslint/eslint#15907)) (Nick Mazuk)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1395
Reviewed-by: 6543 <6543@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Nov 29, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Nov 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing triage An ESLint team member will look at this issue soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants