Merge pull request #22 from palantir/tl/update-release-docs

Update docs about changelog/release process
palantir · Feb 6, 2024 · 0387a28 · 0387a28
2 parents 6aa8409 + c2f0b4b
commit 0387a28
Show file tree

Hide file tree

Showing 29 changed files with 37 additions and 43 deletions.
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -1,8 +1,3 @@
 # Changesets
 
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
+This repository no longer uses changesets for versioning. It currently does continue to use the [changesets publish](https://github.com/changesets/changesets/blob/main/docs/command-line-options.md#publish) command in order to publish new package versions to NPM.
diff --git a/.monorepolint.config.mjs b/.monorepolint.config.mjs
@@ -169,7 +169,8 @@ function standardPackageRules(shared, options) {
           files: [
             "build/types",
             "build/js",
-            "CHANGELOG.md",
+            "changelog",
+            "CHANGELOG_OLD.md",
             "package.json",
             "templates",
 

diff --git a/README.md b/README.md
@@ -11,22 +11,7 @@
 3. `pnpm install`
 4. Start dev mode: `pnpm dev`
 5. Add your code
-6. Add a changeset
-
-   > 📘 Note
-   >
-   > **Follow semver rules here.**
-
-   1. Assuming you've run `pnpm install`, run `changeset` (or `pnpm exec changeset`).
-   2. The tool will split things into changed vs unchanged packages (which you may need if you decide to add changeset logs in a future PR for past features)
-   3. Select the packages you want the changeset applied to using the arrow keys (up/down) and spacebar to "select" the package.
-   4. Press enter to continue.
-   5. The CLI will go through a progression of asking you which pacakges you previously selected need a major bump? Then a minor bump? Patch bumps assumed for remaining packages changed. Arrows and space bar to select. Enter to continue (even if you selected nothing).
-   6. Enter a change (or press enter on empty to open your editor.)
-
-   > Info
-   >
-   > Full docs on the `changesets` tool can be found at the [changesets/changests github repo](https://github.com/changesets/changesets).
-
-7. If you're curious what the final build output might look like you can run `pnpm build` from root.
-8. Run all lint rules and tests with `pnpm check` from root.
+6. If you're curious what the final build output might look like you can run `pnpm build` from root.
+7. Run all lint rules and tests with `pnpm check` from root.
+8. Open a PR
+9. Add a changelog for affected packages through the PR bot comment
diff --git a/examples/basic/cli/package.json b/examples/basic/cli/package.json
@@ -41,7 +41,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/examples/basic/sdk/package.json b/examples/basic/sdk/package.json
@@ -37,11 +37,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": [ ],
+  "keywords": [],
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/examples/one_dot_one/CHANGELOG.md → examples/one_dot_one/CHANGELOG_OLD.md b/examples/one_dot_one/CHANGELOG.md → examples/one_dot_one/CHANGELOG_OLD.md
diff --git a/examples/one_dot_one/package.json b/examples/one_dot_one/package.json
@@ -44,7 +44,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/examples/todoapp/CHANGELOG.md → examples/todoapp/CHANGELOG_OLD.md b/examples/todoapp/CHANGELOG.md → examples/todoapp/CHANGELOG_OLD.md
diff --git a/packages/api/CHANGELOG.md → packages/api/CHANGELOG_OLD.md b/packages/api/CHANGELOG.md → packages/api/CHANGELOG_OLD.md
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -45,7 +45,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/cli/CHANGELOG.md → packages/cli/CHANGELOG_OLD.md b/packages/cli/CHANGELOG.md → packages/cli/CHANGELOG_OLD.md
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -60,7 +60,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/client/CHANGELOG.md → packages/client/CHANGELOG_OLD.md b/packages/client/CHANGELOG.md → packages/client/CHANGELOG_OLD.md
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -49,11 +49,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": [ ],
+  "keywords": [],
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/foundry-sdk-generator/CHANGELOG.md → ...es/foundry-sdk-generator/CHANGELOG_OLD.md b/packages/foundry-sdk-generator/CHANGELOG.md → ...es/foundry-sdk-generator/CHANGELOG_OLD.md
diff --git a/packages/foundry-sdk-generator/package.json b/packages/foundry-sdk-generator/package.json
@@ -50,14 +50,15 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": [ ],
+  "keywords": [],
   "bin": {
     "foundry-sdk-generator": "./bin/foundry-sdk-generator"
   },
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/gateway-generator/CHANGELOG.md → packages/gateway-generator/CHANGELOG_OLD.md b/packages/gateway-generator/CHANGELOG.md → packages/gateway-generator/CHANGELOG_OLD.md
diff --git a/packages/gateway-generator/package.json b/packages/gateway-generator/package.json
@@ -43,7 +43,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/gateway/CHANGELOG.md → packages/gateway/CHANGELOG_OLD.md b/packages/gateway/CHANGELOG.md → packages/gateway/CHANGELOG_OLD.md
diff --git a/packages/gateway/package.json b/packages/gateway/package.json
@@ -40,7 +40,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/generator/CHANGELOG.md → packages/generator/CHANGELOG_OLD.md b/packages/generator/CHANGELOG.md → packages/generator/CHANGELOG_OLD.md
diff --git a/packages/generator/package.json b/packages/generator/package.json
@@ -44,11 +44,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": [ ],
+  "keywords": [],
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/legacy-client/CHANGELOG.md → packages/legacy-client/CHANGELOG_OLD.md b/packages/legacy-client/CHANGELOG.md → packages/legacy-client/CHANGELOG_OLD.md
diff --git a/packages/legacy-client/package.json b/packages/legacy-client/package.json
@@ -50,7 +50,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/shared.net/CHANGELOG.md → packages/shared.net/CHANGELOG_OLD.md b/packages/shared.net/CHANGELOG.md → packages/shared.net/CHANGELOG_OLD.md
diff --git a/packages/shared.net/package.json b/packages/shared.net/package.json
@@ -42,7 +42,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/packages/shared.test/CHANGELOG.md → packages/shared.test/CHANGELOG_OLD.md b/packages/shared.test/CHANGELOG.md → packages/shared.test/CHANGELOG_OLD.md
diff --git a/packages/shared.test/package.json b/packages/shared.test/package.json
@@ -45,7 +45,8 @@
   "files": [
     "build/types",
     "build/js",
-    "CHANGELOG.md",
+    "changelog",
+    "CHANGELOG_OLD.md",
     "package.json",
     "templates",
     "*.d.ts"

diff --git a/tests/verify-fallback-package/CHANGELOG.md → .../verify-fallback-package/CHANGELOG_OLD.md b/tests/verify-fallback-package/CHANGELOG.md → .../verify-fallback-package/CHANGELOG_OLD.md