feat(core): renamed github actions environment package #240
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@stephansama/types-github-action-env": major | ||
| "@stephansama/github-env": major | ||
| --- | ||
|
|
||
| renamed github actions environment package | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,44 @@ | ||||||||||||||
| # @stephansama/github-env | ||||||||||||||
|
There was a problem hiding this comment. The title of the changelog still refers to the old package name. It should be updated to the new package name,
Suggested change
There was a problem hiding this comment. Rename the changelog header to the new package. Line 1 still labels this file as Proposed fix-# `@stephansama/github-env`
+# `@stephansama/types-github-action-env`
+
+Formerly published as `@stephansama/github-env`.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
|
|
||||||||||||||
| ## 0.1.6 | ||||||||||||||
|
|
||||||||||||||
| ### Patch Changes | ||||||||||||||
|
|
||||||||||||||
| - 5d6ed23: switch from npmjs to npmx | ||||||||||||||
|
|
||||||||||||||
| ## 0.1.5 | ||||||||||||||
|
|
||||||||||||||
| ### Patch Changes | ||||||||||||||
|
|
||||||||||||||
| - a307d76: updated dependencies | ||||||||||||||
|
|
||||||||||||||
| ## 0.1.4 | ||||||||||||||
|
|
||||||||||||||
| ### Patch Changes | ||||||||||||||
|
|
||||||||||||||
| - 17e55fe: Updated developer experience and readmes | ||||||||||||||
|
|
||||||||||||||
| ## 0.1.3 | ||||||||||||||
|
|
||||||||||||||
| ### Patch Changes | ||||||||||||||
|
|
||||||||||||||
| - 59750e2: migrated to tsdown | ||||||||||||||
|
|
||||||||||||||
| ## 0.1.2 | ||||||||||||||
|
|
||||||||||||||
| ### Patch Changes | ||||||||||||||
|
|
||||||||||||||
| - 74e34e3: Added more plugins to auto readme. Removed patch dependencies. | ||||||||||||||
| - updated package.jsons with new packages directory structure | ||||||||||||||
|
|
||||||||||||||
| ## 0.1.1 | ||||||||||||||
|
|
||||||||||||||
| ### Patch Changes | ||||||||||||||
|
|
||||||||||||||
| - cdfe284: Updated markdown readme script. removed typedoc from types package | ||||||||||||||
|
|
||||||||||||||
| ## 0.1.0 | ||||||||||||||
|
|
||||||||||||||
| ### Minor Changes | ||||||||||||||
|
|
||||||||||||||
| - 86dce63: Created github environment package | ||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||||||||||||||
| # @stephansama/types-github-action-env | ||||||||||||||||||
|
|
||||||||||||||||||
| [](https://github.com/stephansama/packages/tree/main/core/github-env) | ||||||||||||||||||
| [](https://packages.stephansama.info/api/@stephansama/github-env) | ||||||||||||||||||
| [](https://www.npmx.dev/package/@stephansama/github-env) | ||||||||||||||||||
| [](https://www.npmx.dev/package/@stephansama/github-env) | ||||||||||||||||||
|
Comment on lines
+3
to
+6
There was a problem hiding this comment. The badges in the README point to the old package name (
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| Additional environment variable types for GitHub CI | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Installation | ||||||||||||||||||
|
|
||||||||||||||||||
| To use these type definitions, add the package to your `devDependencies`: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```sh | ||||||||||||||||||
| pnpm install --save-dev @stephansama/github-env | ||||||||||||||||||
|
There was a problem hiding this comment. The installation command uses the old package name. This will cause users to install the deprecated package instead of the new one. Please update it to
Suggested change
|
||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Usage | ||||||||||||||||||
|
|
||||||||||||||||||
| In order to enable the GitHub environment variables into your local scope you can either add the following to your `tsconfig.json` | ||||||||||||||||||
|
|
||||||||||||||||||
| ```json | ||||||||||||||||||
| { | ||||||||||||||||||
| "compilerOptions": { | ||||||||||||||||||
| "types": ["@stephansama/github-env"] | ||||||||||||||||||
|
There was a problem hiding this comment. The usage example for
Suggested change
|
||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| or add the following reference to any typescript file | ||||||||||||||||||
|
|
||||||||||||||||||
| ```ts | ||||||||||||||||||
| /// <reference types="@stephansama/github-env" /> | ||||||||||||||||||
|
There was a problem hiding this comment. The TypeScript reference comment example uses the old package name. This needs to be updated to the new package name,
Suggested change
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| 🎉 Now you have access to GitHub environment variables in your TypeScript files! | ||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| { | ||
| "name": "@stephansama/types-github-action-env", | ||
| "version": "0.1.6", | ||
| "description": "environment variable types for GitHub Action environment", | ||
| "keywords": [ | ||
| "actions", | ||
| "env", | ||
| "environment-variables", | ||
| "github", | ||
| "github-env", | ||
| "process", | ||
| "types", | ||
| "typescript" | ||
| ], | ||
| "homepage": "https://packages.stephansama.info/api/@stephansama/types-github-action-env", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/stephansama/packages.git", | ||
| "directory": "core/types-github-action-env" | ||
| }, | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Stephan Randle", | ||
| "email": "stephanrandle.dev@gmail.com", | ||
| "url": "https://stephansama.info" | ||
| }, | ||
| "type": "module", | ||
| "types": "./src/env.d.ts", | ||
| "files": [ | ||
| "src" | ||
| ], | ||
| "scripts": { | ||
| "prelint": "eslint ./", | ||
| "lint": "publint", | ||
| "type-check": "tsc --noEmit" | ||
| }, | ||
| "packageManager": "pnpm@10.29.3", | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "provenance": true | ||
| } | ||
| } |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make the rename note explicit.
The generated release notes here do not tell consumers what to migrate from and to. Please name both packages so the major bump is actionable.
Proposed fix
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: The official name of this software platform is spelled with a capital “H”.
Context: ...hansama/github-env": major --- renamed github actions environment package
(GITHUB)
🪛 markdownlint-cli2 (0.21.0)
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents