Get ready for automated beta release, enable all C.I. checks #14

NullVoxPopuli · 2023-02-01T15:21:13Z

What's included in this repo's C.I.?

assert that source maps and type-maps are generated
support multiple versions of typescript, per https://www.semver-ts.org/
support multiple versions of ember-source, to ensure a smooth upgrade path for downstream consumers
support embroider so that downstream consumers can be assured that their dependencies are "embroider strict mode safe"
test with no lockfile to try to catch unintended ecosystem deviations / breaking changes (such as what may happen with babel / rollup / etc)

(all of the above is standard in ember OSS projects 🎉 )

extra stuff for this repo:

publish the docs site and post the preview URLs to PRs
configure the auto-release system to do a series of beta versions until we're ready for 1.0.0

What is supported?

minimum ember-source 4.8 -- we can start pretty new, but this also allows us to use the nicest features. Additionally, since we are beta, we can move the minimum ember-source to whichever ember-source ships the built-in-types (as non-preview), without a breaking change
TS 4.8 and 4.9 -- we cannot support earlier than TS 4.8, because Glint does not support prior to TS 4.8
embroider-strict and classic builds

changeset-bot · 2023-02-01T15:22:20Z

⚠️ No Changeset found

Latest commit: aa98d5c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2023-02-01T15:31:54Z

Preview URLs

GH Env: preview
docs: https://0cc0132f.ember-toucan-core.pages.dev
api docs: https://0cc0132f.ember-toucan-core.pages.dev/api/modules.html

NullVoxPopuli · 2023-02-01T15:34:31Z

.changeset/pre.json

@@ -0,0 +1,10 @@
+{
+  "mode": "pre",


this configures our release automation to only do beta releases for now

How exactly does that work here? Will changeset pick a version for us? And if so, will it be a beta release like 1.0.0-beta.0, or will it be 0.x prereleases like 0.1.0?

not sure when things are pre 1.0 -- I assume it'll do 1.0.0-beta.x until we turn off this mode. It'll also update the beta tag on npm -- I did a test with this on ember-toucan-styles, but that was for a 2.0.0 beta that I ended up abandoning -- current version is 1.0.5, and the next beta was 2.0.0-beta.0 -- so that made sense to me. I know pre 1.0 is kind of the wild west, so... we'll see!

ynotdraw · 2023-02-01T16:34:32Z

.github/workflows/ci.yml

+  PostPreviewURLascommenttoPR:
+    name: Post Preview URL as comment to PR
+    runs-on: ubuntu-latest
+    needs: PublishDocstoCloudflarePages
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: ./.github/actions/pnpm
+      - uses: ./.github/actions/download-built-package
+      - uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          message: |+
+            ## Preview URLs
+            GH Env: ${{ needs.PublishDocstoCloudflarePages.outputs.env }}
+            docs: ${{ needs.PublishDocstoCloudflarePages.outputs.url }}
+            api docs: ${{ needs.PublishDocstoCloudflarePages.outputs.url }}/api/modules.html


My second favorite part (first is releasing 😂 ) of all of this - preview URLs! 🎉

we don't yet have api docs, but when we do! this URL will be ready!
(I'm thinking for toucan-core, this makes the most sense for test-helpers and all that)

(I'm thinking for toucan-core, this makes the most sense for test-helpers and all that)

makes sense to me 👍

NullVoxPopuli · 2023-02-01T19:34:54Z

This PR addresses a real bug in ember-browser-services and unblocks this PR: CrowdStrike/ember-browser-services#364

NullVoxPopuli · 2023-02-02T19:55:09Z

docs-app/types/glint-registry.d.ts

@@ -1,8 +1,8 @@
 import '@glint/environment-ember-loose';
 import '@glint/environment-ember-template-imports';
-// Types from libraries
-import '@crowdstrike/ember-oss-docs/glint';


side-effecting imports are no longer recommended for merging the glint registry, because the number of copies of @glint/environment-ember-loose/registry in a project's node_modules is too variable.

NullVoxPopuli · 2023-02-02T19:55:47Z

package.json

  },
  "pnpm": {
+    "overrides": {
+      "@types/eslint": "^8.0.0"


ember-template-lint's dependency of @lint-todo brings in @types/eslint v7 🙈

NullVoxPopuli · 2023-02-02T19:56:44Z

test-app/package.json

@@ -76,6 +76,7 @@
    "broccoli-asset-rev": "^3.0.0",
    "concurrently": "^7.6.0",
    "ember-auto-import": "^2.5.0",
+    "ember-browser-services": "^4.0.4",


this works around an issue in embroider which will be fixed in the next release -- ultimately though, I think we may want to make this a peer eventually anyway, depending on what our components end up doing -- only time will tell though.

ynotdraw

This is exciting!

ynotdraw · 2023-02-02T19:58:49Z

.github/workflows/ci.yml

+  floating_tests:
+    name: Floating Deps Test
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/pnpm
+      - name: Install Dependencies (without lockfile)
+        run: rm pnpm-lock.yaml && pnpm install
+      - uses: ./.github/actions/download-built-package
+      - run: pnpm --filter test-app test:ember


Is the idea for these to catch cases where breaking changes are introduced by package authors not following proper semver?

yeah, either that, or accidental breaking changes, such as what happened recently here: wessberg/rollup-plugin-ts#202

Ultimately SemVer is a social contract, and as such, is prone to human error 😅

Totally! Makes sense to me. Thank ya for the context

Explains a lot to me too!

accidental breaking changes also includes bugs, which also tend to not follow semver 🤪

Even when that's not our fault, it's good to have visibility about things failing, to raise issues upstream and prevent "works on my machine"™ like scenarios...

nicolechung · 2023-02-02T21:40:11Z

docs: https://0cc0132f.ember-toucan-core.pages.dev/

Woohoo! Docs!

nicolechung · 2023-02-02T21:52:04Z

ember-toucan-core/package.json

@@ -85,7 +85,7 @@
    "concurrently": "^7.2.1",
    "ember-cli-htmlbars": "^6.1.1",
    "ember-source": "~4.9.2",
-    "ember-template-lint": "^4.0.0",
+    "ember-template-lint": "^5.3.3",


Wow...so many packages updated in just a month

nicolechung

🎉

simonihmig

Nice! 🚀

simonihmig · 2023-02-03T09:04:59Z

.changeset/pre.json

@@ -0,0 +1,10 @@
+{
+  "mode": "pre",


How exactly does that work here? Will changeset pick a version for us? And if so, will it be a beta release like 1.0.0-beta.0, or will it be 0.x prereleases like 0.1.0?

simonihmig · 2023-02-03T09:09:59Z

.changeset/pre.json

+  "tag": "beta",
+  "initialVersions": {
+    "docs-app": "0.0.0",
+    "@crowdstrike/ember-toucan-core": "0.0.0",


This depends on the answer to the previous question, but just to point this out: the 0.0.x releases are a bit tricky and awkward IMO, as according to how npm version modifiers work any new patch release like 0.0.x+1 is considered a breaking change, as ^0.0.1 would not allow 0.0.2 to be used. So unless our API is really like super unstable, I would start with 0.1.0 (as ^0.1.0 would cover all 0.1.x releases then).

simonihmig · 2023-02-03T09:14:31Z

.github/workflows/ci.yml

+  floating_tests:
+    name: Floating Deps Test
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/pnpm
+      - name: Install Dependencies (without lockfile)
+        run: rm pnpm-lock.yaml && pnpm install
+      - uses: ./.github/actions/download-built-package
+      - run: pnpm --filter test-app test:ember


accidental breaking changes also includes bugs, which also tend to not follow semver 🤪

Even when that's not our fault, it's good to have visibility about things failing, to raise issues upstream and prevent "works on my machine"™ like scenarios...

simonihmig · 2023-02-03T09:21:17Z

.github/workflows/ci.yml

+          persist-credentials: false
+      - uses: ./.github/actions/pnpm
+      - uses: ./.github/actions/download-built-package
+      - uses: marocchino/sticky-pull-request-comment@v2


I have used similar things before, but this one is really nice with its update capabilities! 😍

simonihmig · 2023-02-03T09:24:20Z

.github/workflows/ci.yml

+        uses: cloudflare/pages-action@1
+        with:
+          apiToken: ${{ secrets.UX_OSS_CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.UX_OSS_CLOUDFLARE_ACCOUNT_ID }}


I don't have the powers to see the repo/org secrets in this Github, so wondering, are these repo- or org-wide secrets? Or to rephrase: is this already available e.g. in the forms repo?

they are org-wide -- tokens configured in the org settings -- and are explicitly allowed per repo that needs them (as opposed to all repos by default) -- if forms is ready for docs, I can add these to the forms repo 🎉

simonihmig · 2023-02-03T09:25:55Z

.github/workflows/ci.yml

+      - default_tests
+      - floating_tests
+      - typecheck
+      - try_scenarios


I guess we cannot split things up a bit into different workflows (like CI/release/docs) due to not being able to reference needs across workflows, right?

simonihmig · 2023-02-03T09:29:18Z

docs-app/types/glint-registry.d.ts

@@ -17,7 +17,7 @@ declare module '@ember/modifier' {
 }

 declare module '@glint/environment-ember-loose/registry' {
-  export default interface Registry {
+  export default interface Registry extends OSSDocs {


simonihmig · 2023-02-03T09:30:50Z

ember-toucan-core/package.json

@@ -96,7 +96,7 @@
    "postcss": "^8.2.14",
    "prettier": "^2.8.3",
    "prettier-plugin-ember-template-tag": "^0.3.0",
-    "rollup": "^2.67.0",
+    "rollup": "^3.12.1",


Oh! Yeah, I remember I wanted to update this also in the blueprint, but didn't look yet into what it takes (breaking changes)... seems... nothing?

yeah, looks like they did the 3.0 major the ember way,

drop old node

remove deprecated code

some internal stuff that doesn't matter to consumers

NullVoxPopuli added 2 commits February 1, 2023 10:18

Enable everything

182470c

Install changeset dependencies and start beta release cycle

a3797b2

NullVoxPopuli changed the title ~~Get ready for release, enable all C.I. checks~~ Get ready for automated beta release, enable all C.I. checks Feb 1, 2023

Use correct cloudflare pages name

98d7e6e

NullVoxPopuli added 2 commits February 1, 2023 10:26

Fix ci config

9274868

Use correct test-app path

000d2ef

Get glint working better in the docs-app

cc6ff4e

NullVoxPopuli commented Feb 1, 2023

View reviewed changes

NullVoxPopuli added 2 commits February 1, 2023 10:46

Update ember-try config

b60ac86

Update try scenarios in ci.yml

ce7c3cd

ynotdraw reviewed Feb 1, 2023

View reviewed changes

NullVoxPopuli mentioned this pull request Feb 1, 2023

General maintenance CrowdStrike/ember-browser-services#364

Merged

NullVoxPopuli added 4 commits February 1, 2023 15:31

Upgrade ember-browser-services

d152d70

Upgrade some dependencies

6a7e2cf

Pin @types/eslint to 8

d9f14f8

pnpm dedupe

aa98d5c

NullVoxPopuli marked this pull request as ready for review February 2, 2023 19:53

NullVoxPopuli requested review from nicolechung, simonihmig and ynotdraw February 2, 2023 19:53

NullVoxPopuli commented Feb 2, 2023

View reviewed changes

ynotdraw approved these changes Feb 2, 2023

View reviewed changes

nicolechung reviewed Feb 2, 2023

View reviewed changes

nicolechung approved these changes Feb 2, 2023

View reviewed changes

NullVoxPopuli merged commit 9be2d5f into main Feb 2, 2023

NullVoxPopuli deleted the get-ready branch February 2, 2023 22:09

simonihmig reviewed Feb 3, 2023

View reviewed changes

NullVoxPopuli mentioned this pull request Feb 6, 2023

Get ready for automated beta release, enable all C.I. checks CrowdStrike/ember-headless-form#30

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get ready for automated beta release, enable all C.I. checks #14

Get ready for automated beta release, enable all C.I. checks #14

NullVoxPopuli commented Feb 1, 2023 •

edited

Loading

changeset-bot bot commented Feb 1, 2023 •

edited

Loading

github-actions bot commented Feb 1, 2023 •

edited

Loading

NullVoxPopuli Feb 1, 2023

simonihmig Feb 3, 2023

NullVoxPopuli Feb 3, 2023 •

edited

Loading

ynotdraw Feb 1, 2023 •

edited

Loading

NullVoxPopuli Feb 1, 2023

ynotdraw Feb 1, 2023 •

edited

Loading

NullVoxPopuli commented Feb 1, 2023

NullVoxPopuli Feb 2, 2023

NullVoxPopuli Feb 2, 2023

NullVoxPopuli Feb 2, 2023

ynotdraw left a comment

ynotdraw Feb 2, 2023

NullVoxPopuli Feb 2, 2023

ynotdraw Feb 2, 2023

nicolechung Feb 2, 2023

simonihmig Feb 3, 2023

nicolechung commented Feb 2, 2023

nicolechung Feb 2, 2023

nicolechung left a comment

simonihmig left a comment

simonihmig Feb 3, 2023

simonihmig Feb 3, 2023

simonihmig Feb 3, 2023

simonihmig Feb 3, 2023

simonihmig Feb 3, 2023

NullVoxPopuli Feb 3, 2023

simonihmig Feb 3, 2023

NullVoxPopuli Feb 3, 2023

simonihmig Feb 3, 2023

simonihmig Feb 3, 2023

NullVoxPopuli Feb 3, 2023

Get ready for automated beta release, enable all C.I. checks #14

Get ready for automated beta release, enable all C.I. checks #14

Conversation

NullVoxPopuli commented Feb 1, 2023 • edited Loading

What's included in this repo's C.I.?

What is supported?

changeset-bot bot commented Feb 1, 2023 • edited Loading

⚠️ No Changeset found

github-actions bot commented Feb 1, 2023 • edited Loading

Preview URLs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NullVoxPopuli Feb 3, 2023 • edited Loading

Choose a reason for hiding this comment

ynotdraw Feb 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ynotdraw Feb 1, 2023 • edited Loading

Choose a reason for hiding this comment

NullVoxPopuli commented Feb 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ynotdraw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolechung commented Feb 2, 2023

Choose a reason for hiding this comment

nicolechung left a comment

Choose a reason for hiding this comment

simonihmig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NullVoxPopuli commented Feb 1, 2023 •

edited

Loading

changeset-bot bot commented Feb 1, 2023 •

edited

Loading

github-actions bot commented Feb 1, 2023 •

edited

Loading

NullVoxPopuli Feb 3, 2023 •

edited

Loading

ynotdraw Feb 1, 2023 •

edited

Loading

ynotdraw Feb 1, 2023 •

edited

Loading