Merge pull request #700 from actions/salmanmkc/expose-getoctokit + pr… · actions/github-script@3a2844b · GitHub

actions / github-script Public

• Notifications You must be signed in to change notification settings
• Fork 583
• Star 5k

• Code
• Issues 58
• Pull requests 35
• Discussions
• Actions
• Security and quality
• Insights

Additional navigation options

Commit 3a2844b

Browse filesBrowse the repository at this point in the historyBrowse files

salmanmkc

authored

Merge pull request #700 from actions/salmanmkc/expose-getoctokit + prepare release for v9

feat!: add getOctokit to script context, upgrade @actions/github v9, @octokit/core v7, and related packages

2 parents afff112 + ca10bbd commit 3a2844b
Copy full SHA for 3a2844b

35 files changed

+58,611-28,916Lines changed: 58611 additions & 28916 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• .github/workflows
  • integration.yml
• .licenses/npm
  • @actions
    • github.dep.yml
    • http-client-2.2.0.dep.yml
    • http-client-3.0.2.dep.yml
  • @octokit
    • auth-token.dep.yml
    • core.dep.yml
    • endpoint.dep.yml
    • graphql.dep.yml
    • openapi-types.dep.yml
    • plugin-paginate-rest.dep.yml
    • plugin-request-log.dep.yml
    • plugin-rest-endpoint-methods.dep.yml
    • plugin-retry.dep.yml
    • request-error.dep.yml
    • request.dep.yml
    • types.dep.yml
  • before-after-hook.dep.yml
  • fast-content-type-parse.dep.yml
  • json-with-bigint.dep.yml
  • undici-5.28.5.dep.yml
  • undici-6.24.1.dep.yml
  • universal-user-agent.dep.yml
• README.md
• __test__
  • async-function.test.ts
  • create-configured-getoctokit.test.ts
  • getoctokit-integration.test.ts
• dist
  • index.js
• package-lock.json
• package.json
• src
  • async-function.ts
  • create-configured-getoctokit.ts
  • main.ts
  • retry-options.ts
• tsconfig.json
• types
  • async-function.d.ts

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎.github/workflows/integration.yml‎

Copy file name to clipboardExpand all lines: .github/workflows/integration.yml

+40-7Lines changed: 40 additions & 7 deletions

Original file line number	Diff line number	Diff line change
@@ -42,7 +42,8 @@ jobs:
42	42	result-encoding: string
43	43	- run: |
44	44	echo "- Validating relative require output"
45		- if [[ "${{steps.relative-require.outputs.result}}" != "@actions/github-script" ]]; then
	45	+ expected="@actions/github-script"
	46	+ if [[ "${{steps.relative-require.outputs.result}}" != "$expected" ]]; then
46	47	echo $'::error::\u274C' "Expected '$expected', got ${{steps.relative-require.outputs.result}}"
47	48	exit 1
48	49	fi
@@ -154,22 +155,54 @@ jobs:
154	155	return endpoint({}).headers['user-agent']
155	156	result-encoding: string
156	157	- run: |
	158	+ # User-agent format: <prefix> [actions_orchestration_id/<id>] octokit-core.js/<version> ...
	159	+ # When ACTIONS_ORCHESTRATION_ID is set, the orchestration ID is inserted after the prefix
157	160	echo "- Validating user-agent default"
158	161	ua="${{steps.user-agent-default.outputs.result}}"
159		- if [[ "$ua" != "actions/github-script octokit-core.js/"* ]] && [[ "$ua" != "actions/github-script actions_orchestration_id/"* ]]; then
160		- echo $'::error::\u274C' "Expected user-agent to start with 'actions/github-script', got $ua"
	162	+ if [[ "$ua" != "actions/github-script"* ]] || [[ "$ua" != *"octokit-core.js/"* ]]; then
	163	+ echo $'::error::\u274C' "Expected user-agent to start with 'actions/github-script' and contain 'octokit-core.js/', got $ua"
161	164	exit 1
162	165	fi
163	166	echo "- Validating user-agent set to a value"
164	167	ua="${{steps.user-agent-set.outputs.result}}"
165		- if [[ "$ua" != "foobar octokit-core.js/"* ]] && [[ "$ua" != "foobar actions_orchestration_id/"* ]]; then
166		- echo $'::error::\u274C' "Expected user-agent to start with 'foobar', got $ua"
	168	+ if [[ "$ua" != "foobar"* ]] || [[ "$ua" != *"octokit-core.js/"* ]]; then
	169	+ echo $'::error::\u274C' "Expected user-agent to start with 'foobar' and contain 'octokit-core.js/', got $ua"
167	170	exit 1
168	171	fi
169	172	echo "- Validating user-agent set to an empty string"
170	173	ua="${{steps.user-agent-empty.outputs.result}}"
171		- if [[ "$ua" != "actions/github-script octokit-core.js/"* ]] && [[ "$ua" != "actions/github-script actions_orchestration_id/"* ]]; then
172		- echo $'::error::\u274C' "Expected user-agent to start with 'actions/github-script', got $ua"
	174	+ if [[ "$ua" != "actions/github-script"* ]] || [[ "$ua" != *"octokit-core.js/"* ]]; then
	175	+ echo $'::error::\u274C' "Expected user-agent to start with 'actions/github-script' and contain 'octokit-core.js/', got $ua"
	176	+ exit 1
	177	+ fi
	178	+ echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY
	179	+
	180	+ test-get-octokit:
	181	+ name: 'Integration test: getOctokit with token'
	182	+ runs-on: ubuntu-latest
	183	+ steps:
	184	+ - uses: actions/checkout@v4
	185	+ - uses: ./.github/actions/install-dependencies
	186	+ - id: secondary-client
	187	+ name: Create a second client with getOctokit
	188	+ uses: ./
	189	+ env:
	190	+ APP_TOKEN: ${{ github.token }}
	191	+ with:
	192	+ script: |
	193	+ const appOctokit = getOctokit(process.env.APP_TOKEN)
	194	+ const {data} = await appOctokit.rest.repos.get({
	195	+ owner: context.repo.owner,
	196	+ repo: context.repo.repo
	197	+ })
	198	+
	199	+ return `${appOctokit !== github}:${data.full_name}`
	200	+ result-encoding: string
	201	+ - run: |
	202	+ echo "- Validating secondary client output"
	203	+ expected="true:${{ github.repository }}"
	204	+ if [[ "${{steps.secondary-client.outputs.result}}" != "$expected" ]]; then
	205	+ echo $'::error::\u274C' "Expected '$expected', got ${{steps.secondary-client.outputs.result}}"
173	206	exit 1
174	207	fi
175	208	echo $'\u2705 Test passed' | tee -a $GITHUB_STEP_SUMMARY

Collapse file

‎.licenses/npm/@actions/github.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@actions/github.dep.yml

+1-1Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@actions/http-client-2.2.0.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@actions/http-client-2.2.0.dep.yml

+32Lines changed: 32 additions & 0 deletions

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@actions/http-client-3.0.2.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@actions/http-client-3.0.2.dep.yml

+32Lines changed: 32 additions & 0 deletions

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@octokit/auth-token.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@octokit/auth-token.dep.yml

+1-1Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@octokit/core.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@octokit/core.dep.yml

+1-1Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@octokit/endpoint.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@octokit/endpoint.dep.yml

+1-1Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@octokit/graphql.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@octokit/graphql.dep.yml

+1-1Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@octokit/openapi-types.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@octokit/openapi-types.dep.yml

+20Lines changed: 20 additions & 0 deletions

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎.licenses/npm/@octokit/plugin-paginate-rest.dep.yml‎

Copy file name to clipboardExpand all lines: .licenses/npm/@octokit/plugin-paginate-rest.dep.yml

+1-1Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments

0 (0)