mirror of https://github.com/actions/toolkit
Set main as the default branch (#527)
* set main as the default branch * revert change to tool-cache default branch * use versions where applicablepull/530/head
parent
cb18a3df6b
commit
ccad19055e
|
@ -2,7 +2,7 @@ name: artifact-unit-tests
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: toolkit-audit
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: cache-unit-tests
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: toolkit-unit-tests
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**.md'
|
- '**.md'
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
|
@ -37,7 +37,7 @@ jobs:
|
||||||
script: |
|
script: |
|
||||||
github.pulls.create(
|
github.pulls.create(
|
||||||
{
|
{
|
||||||
base: "master",
|
base: "main",
|
||||||
owner: "${{github.repository_owner}}",
|
owner: "${{github.repository_owner}}",
|
||||||
repo: "toolkit",
|
repo: "toolkit",
|
||||||
title: "Update Octokit dependencies",
|
title: "Update Octokit dependencies",
|
||||||
|
|
|
@ -32,14 +32,14 @@ jobs:
|
||||||
os: [ubuntu-16.04, windows-2019]
|
os: [ubuntu-16.04, windows-2019]
|
||||||
runs-on: ${{matrix.os}}
|
runs-on: ${{matrix.os}}
|
||||||
actions:
|
actions:
|
||||||
- uses: actions/setup-node@master
|
- uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
version: ${{matrix.node}}
|
version: ${{matrix.node}}
|
||||||
- run: |
|
- run: |
|
||||||
npm install
|
npm install
|
||||||
- run: |
|
- run: |
|
||||||
npm test
|
npm test
|
||||||
- uses: actions/custom-action@master
|
- uses: actions/custom-action@v1
|
||||||
```
|
```
|
||||||
|
|
||||||
JavaScript actions work on any environment that host action runtime is supported on which is currently node 12. However, a host action that runs a toolset expects the environment that it's running on to have that toolset in its PATH or using a setup-* action to acquire it on demand.
|
JavaScript actions work on any environment that host action runtime is supported on which is currently node 12. However, a host action that runs a toolset expects the environment that it's running on to have that toolset in its PATH or using a setup-* action to acquire it on demand.
|
||||||
|
|
|
@ -17,13 +17,13 @@ Binding to a major version is the latest of that major version ( e.g. `v1` == "1
|
||||||
|
|
||||||
Major versions should guarantee compatibility. A major version can add net new capabilities but should not break existing input compatibility or break existing workflows.
|
Major versions should guarantee compatibility. A major version can add net new capabilities but should not break existing input compatibility or break existing workflows.
|
||||||
|
|
||||||
Major version binding allows you to take advantage of bug fixes and critical functionality and security fixes. The `master` branch has the latest code and is unstable to bind to since changes get committed to master and released to the market place by creating a tag. In addition, a new major version carrying breaking changes will get implemented in master after branching off the previous major version.
|
Major version binding allows you to take advantage of bug fixes and critical functionality and security fixes. The `main` branch has the latest code and is unstable to bind to since changes get committed to main and released to the market place by creating a tag. In addition, a new major version carrying breaking changes will get implemented in main after branching off the previous major version.
|
||||||
|
|
||||||
> Warning: do not reference `master` since that is the latest code and can be carrying breaking changes of the next major version.
|
> Warning: do not reference `main` since that is the latest code and can be carrying breaking changes of the next major version.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/javascript-action@master # do not do this
|
- uses: actions/javascript-action@main # do not do this
|
||||||
```
|
```
|
||||||
|
|
||||||
Binding to the immutable full sha1 may offer more reliability. However, note that the hosted images toolsets (e.g. ubuntu-latest) move forward and if there is a tool breaking issue, actions may react with a patch to a major version to compensate so binding to a specific SHA may prevent you from getting fixes.
|
Binding to the immutable full sha1 may offer more reliability. However, note that the hosted images toolsets (e.g. ubuntu-latest) move forward and if there is a tool breaking issue, actions may react with a patch to a major version to compensate so binding to a specific SHA may prevent you from getting fixes.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# :: Commands
|
# :: Commands
|
||||||
|
|
||||||
The [core toolkit package](https://github.com/actions/toolkit/tree/master/packages/core) offers a number of convenience functions for
|
The [core toolkit package](https://github.com/actions/toolkit/tree/main/packages/core) offers a number of convenience functions for
|
||||||
setting results, logging, registering secrets and exporting variables across actions. Sometimes, however, its useful to be able to do
|
setting results, logging, registering secrets and exporting variables across actions. Sometimes, however, its useful to be able to do
|
||||||
these things in a script or other tool.
|
these things in a script or other tool.
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ e.g. To use https://github.com/actions/setup-node, users will author:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
using: actions/setup-node@master
|
using: actions/setup-node@v1
|
||||||
```
|
```
|
||||||
|
|
||||||
# Define Metadata
|
# Define Metadata
|
||||||
|
|
|
@ -111,10 +111,10 @@ Registering two problem-matchers with the same owner will result in only the pro
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Some of the starter actions are already using problem matchers, for example:
|
Some of the starter actions are already using problem matchers, for example:
|
||||||
- [setup-node](https://github.com/actions/setup-node/tree/master/.github)
|
- [setup-node](https://github.com/actions/setup-node/tree/main/.github)
|
||||||
- [setup-python](https://github.com/actions/setup-python/tree/master/.github)
|
- [setup-python](https://github.com/actions/setup-python/tree/main/.github)
|
||||||
- [setup-go](https://github.com/actions/setup-go/tree/master/.github)
|
- [setup-go](https://github.com/actions/setup-go/tree/main/.github)
|
||||||
- [setup-dotnet](https://github.com/actions/setup-dotnet/tree/master/.github)
|
- [setup-dotnet](https://github.com/actions/setup-dotnet/tree/main/.github)
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
|
|
@ -203,6 +203,6 @@ Check out [implementation-details](docs/implementation-details.md) for extra inf
|
||||||
|
|
||||||
## Contributions
|
## Contributions
|
||||||
|
|
||||||
See [contributor guidelines](https://github.com/actions/toolkit/blob/master/.github/CONTRIBUTING.md) for general guidelines and information about toolkit contributions.
|
See [contributor guidelines](https://github.com/actions/toolkit/blob/main/.github/CONTRIBUTING.md) for general guidelines and information about toolkit contributions.
|
||||||
|
|
||||||
For contributions related to this package, see [artifact contributions](CONTRIBUTIONS.md) for more information.
|
For contributions related to this package, see [artifact contributions](CONTRIBUTIONS.md) for more information.
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"artifact"
|
"artifact"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/artifact",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/artifact",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/artifact-client.js",
|
"main": "lib/artifact-client.js",
|
||||||
"types": "lib/artifact-client.d.ts",
|
"types": "lib/artifact-client.d.ts",
|
||||||
|
|
|
@ -104,7 +104,7 @@ test('restore with gzip compressed cache found', async () => {
|
||||||
|
|
||||||
const cacheEntry: ArtifactCacheEntry = {
|
const cacheEntry: ArtifactCacheEntry = {
|
||||||
cacheKey: key,
|
cacheKey: key,
|
||||||
scope: 'refs/heads/master',
|
scope: 'refs/heads/main',
|
||||||
archiveLocation: 'www.actionscache.test/download'
|
archiveLocation: 'www.actionscache.test/download'
|
||||||
}
|
}
|
||||||
const getCacheMock = jest.spyOn(cacheHttpClient, 'getCacheEntry')
|
const getCacheMock = jest.spyOn(cacheHttpClient, 'getCacheEntry')
|
||||||
|
@ -166,7 +166,7 @@ test('restore with zstd compressed cache found', async () => {
|
||||||
|
|
||||||
const cacheEntry: ArtifactCacheEntry = {
|
const cacheEntry: ArtifactCacheEntry = {
|
||||||
cacheKey: key,
|
cacheKey: key,
|
||||||
scope: 'refs/heads/master',
|
scope: 'refs/heads/main',
|
||||||
archiveLocation: 'www.actionscache.test/download'
|
archiveLocation: 'www.actionscache.test/download'
|
||||||
}
|
}
|
||||||
const getCacheMock = jest.spyOn(cacheHttpClient, 'getCacheEntry')
|
const getCacheMock = jest.spyOn(cacheHttpClient, 'getCacheEntry')
|
||||||
|
@ -223,7 +223,7 @@ test('restore with cache found for restore key', async () => {
|
||||||
|
|
||||||
const cacheEntry: ArtifactCacheEntry = {
|
const cacheEntry: ArtifactCacheEntry = {
|
||||||
cacheKey: restoreKey,
|
cacheKey: restoreKey,
|
||||||
scope: 'refs/heads/master',
|
scope: 'refs/heads/main',
|
||||||
archiveLocation: 'www.actionscache.test/download'
|
archiveLocation: 'www.actionscache.test/download'
|
||||||
}
|
}
|
||||||
const getCacheMock = jest.spyOn(cacheHttpClient, 'getCacheEntry')
|
const getCacheMock = jest.spyOn(cacheHttpClient, 'getCacheEntry')
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"cache"
|
"cache"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/cache",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/cache",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/cache.js",
|
"main": "lib/cache.js",
|
||||||
"types": "lib/cache.d.ts",
|
"types": "lib/cache.d.ts",
|
||||||
|
|
|
@ -9,7 +9,7 @@ import * as util from 'util'
|
||||||
import {v4 as uuidV4} from 'uuid'
|
import {v4 as uuidV4} from 'uuid'
|
||||||
import {CacheFilename, CompressionMethod} from './constants'
|
import {CacheFilename, CompressionMethod} from './constants'
|
||||||
|
|
||||||
// From https://github.com/actions/toolkit/blob/master/packages/tool-cache/src/tool-cache.ts#L23
|
// From https://github.com/actions/toolkit/blob/main/packages/tool-cache/src/tool-cache.ts#L23
|
||||||
export async function createTempDirectory(): Promise<string> {
|
export async function createTempDirectory(): Promise<string> {
|
||||||
const IS_WINDOWS = process.platform === 'win32'
|
const IS_WINDOWS = process.platform === 'win32'
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"core"
|
"core"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/core",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/core",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/core.js",
|
"main": "lib/core.js",
|
||||||
"types": "lib/core.d.ts",
|
"types": "lib/core.d.ts",
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"exec"
|
"exec"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/exec",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/exec",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/exec.js",
|
"main": "lib/exec.js",
|
||||||
"types": "lib/exec.d.ts",
|
"types": "lib/exec.d.ts",
|
||||||
|
|
|
@ -52,9 +52,9 @@ describe('@actions/github', () => {
|
||||||
const branch = await octokit.repos.getBranch({
|
const branch = await octokit.repos.getBranch({
|
||||||
owner: 'actions',
|
owner: 'actions',
|
||||||
repo: 'toolkit',
|
repo: 'toolkit',
|
||||||
branch: 'master'
|
branch: 'main'
|
||||||
})
|
})
|
||||||
expect(branch.data.name).toBe('master')
|
expect(branch.data.name).toBe('main')
|
||||||
expect(proxyConnects).toEqual(['api.github.com:443'])
|
expect(proxyConnects).toEqual(['api.github.com:443'])
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -88,9 +88,9 @@ describe('@actions/github', () => {
|
||||||
const branch = await octokit.repos.getBranch({
|
const branch = await octokit.repos.getBranch({
|
||||||
owner: 'actions',
|
owner: 'actions',
|
||||||
repo: 'toolkit',
|
repo: 'toolkit',
|
||||||
branch: 'master'
|
branch: 'main'
|
||||||
})
|
})
|
||||||
expect(branch.data.name).toBe('master')
|
expect(branch.data.name).toBe('main')
|
||||||
expect(proxyConnects).toHaveLength(0)
|
expect(proxyConnects).toHaveLength(0)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
|
@ -48,9 +48,9 @@ describe('@actions/github', () => {
|
||||||
const branch = await octokit.repos.getBranch({
|
const branch = await octokit.repos.getBranch({
|
||||||
owner: 'actions',
|
owner: 'actions',
|
||||||
repo: 'toolkit',
|
repo: 'toolkit',
|
||||||
branch: 'master'
|
branch: 'main'
|
||||||
})
|
})
|
||||||
expect(branch.data.name).toBe('master')
|
expect(branch.data.name).toBe('main')
|
||||||
expect(proxyConnects).toHaveLength(0)
|
expect(proxyConnects).toHaveLength(0)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -63,9 +63,9 @@ describe('@actions/github', () => {
|
||||||
const branch = await octokit.repos.getBranch({
|
const branch = await octokit.repos.getBranch({
|
||||||
owner: 'actions',
|
owner: 'actions',
|
||||||
repo: 'toolkit',
|
repo: 'toolkit',
|
||||||
branch: 'master'
|
branch: 'main'
|
||||||
})
|
})
|
||||||
expect(branch.data.name).toBe('master')
|
expect(branch.data.name).toBe('main')
|
||||||
expect(proxyConnects).toHaveLength(0)
|
expect(proxyConnects).toHaveLength(0)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -80,9 +80,9 @@ describe('@actions/github', () => {
|
||||||
const branch = await octokit.repos.getBranch({
|
const branch = await octokit.repos.getBranch({
|
||||||
owner: 'actions',
|
owner: 'actions',
|
||||||
repo: 'toolkit',
|
repo: 'toolkit',
|
||||||
branch: 'master'
|
branch: 'main'
|
||||||
})
|
})
|
||||||
expect(branch.data.name).toBe('master')
|
expect(branch.data.name).toBe('main')
|
||||||
expect(proxyConnects).toHaveLength(0)
|
expect(proxyConnects).toHaveLength(0)
|
||||||
|
|
||||||
// Invalid token
|
// Invalid token
|
||||||
|
@ -92,7 +92,7 @@ describe('@actions/github', () => {
|
||||||
await octokit.repos.getBranch({
|
await octokit.repos.getBranch({
|
||||||
owner: 'actions',
|
owner: 'actions',
|
||||||
repo: 'toolkit',
|
repo: 'toolkit',
|
||||||
branch: 'master'
|
branch: 'main'
|
||||||
})
|
})
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
failed = true
|
failed = true
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
"github",
|
"github",
|
||||||
"actions"
|
"actions"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/github",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/github",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/github.js",
|
"main": "lib/github.js",
|
||||||
"types": "lib/github.d.ts",
|
"types": "lib/github.d.ts",
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/master/src/context.ts
|
// Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/main/src/context.ts
|
||||||
import {WebhookPayload} from './interfaces'
|
import {WebhookPayload} from './interfaces'
|
||||||
import {readFileSync, existsSync} from 'fs'
|
import {readFileSync, existsSync} from 'fs'
|
||||||
import {EOL} from 'os'
|
import {EOL} from 'os'
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"glob"
|
"glob"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/glob",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/glob",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/glob.js",
|
"main": "lib/glob.js",
|
||||||
"types": "lib/glob.d.ts",
|
"types": "lib/glob.d.ts",
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"io"
|
"io"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/io",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/io",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/io.js",
|
"main": "lib/io.js",
|
||||||
"types": "lib/io.d.ts",
|
"types": "lib/io.d.ts",
|
||||||
|
|
|
@ -8,7 +8,7 @@ import osm = require('os')
|
||||||
import cp = require('child_process')
|
import cp = require('child_process')
|
||||||
//import {coerce} from 'semver'
|
//import {coerce} from 'semver'
|
||||||
|
|
||||||
// we fetch the manifest file from master of a repo
|
// we fetch the manifest file from main of a repo
|
||||||
const owner = 'actions'
|
const owner = 'actions'
|
||||||
const repo = 'some-tool'
|
const repo = 'some-tool'
|
||||||
const fakeToken = 'notrealtoken'
|
const fakeToken = 'notrealtoken'
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
"actions",
|
"actions",
|
||||||
"exec"
|
"exec"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/actions/toolkit/tree/master/packages/tool-cache",
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/tool-cache",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "lib/tool-cache.js",
|
"main": "lib/tool-cache.js",
|
||||||
"types": "lib/tool-cache.d.ts",
|
"types": "lib/tool-cache.d.ts",
|
||||||
|
|
Loading…
Reference in New Issue