embroider-build / create-release-plan-setup Goto Github PK

View Code? Open in Web Editor NEW

6.0 6.0 6.0 1.71 MB

License: MIT License

JavaScript 77.94% EJS 22.06%

create-release-plan-setup's People

Contributors

Stargazers

Watchers

Forkers

nullvoxpopuli robbiethewagner bertdeblock beerinho

create-release-plan-setup's Issues

Update workflows to use explicit permissions

I found that these work:

    permissions:
      contents: write
      pull-requests: write

setting these were required on an org that didn't have "Read & Write" selected for repos.

Here is a screenshot of the settings that had me manually add permissions

(just needed on publish (of publish.yml) and prepare_release_notes of (plan-release.yml))

private packgaes not ignored by changelog generation/preview

https://github.com/NullVoxPopuli/limber/actions/runs/8218048537/job/22474435700

my release-plan setup is up to date:

limber-2 on  main [$] 
❯ npx create-release-plan-setup@latest --update

limber-2 on  main [$] took 7s 
❯ gs
On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean

package.json keys sorting is deeply changed after running this tool

Normally 🤷 , but this has an impact on exports, since the order of those matters. (types must come before default, but alphabetically, types is after default)

Issues when adding `release-plan` to fresh project

I tried to add release-plan to an almost brand new svelte add-on app and after a straight-forward setup the initial PR gave this error:

release prepare

Edits the package.json and changelog files to prepare for release.

Options:
--version Show version number [boolean]
--help Show help [boolean]
--fromStdin Read the summary of changes from stdin instead of building
them from scratch. [boolean]
--singlePackage Allows you to run this command in a non monorepo and define
the package name [string]

Error: Command failed with exit code 1: node /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/bin/cli.js --next-version Release
Error: Command failed with exit code 128: git describe --abbrev=0 --tags
fatal: No names found, cannot describe anything.
at makeError (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/lib/error.js:60:11)
at module.exports.sync (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/index.js:194:17)
at Object.lastTag (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/git.js:31:18)
at Changelog. (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:32:56)
at Generator.next ()
at /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:8:71
at new Promise ()
at __awaiter (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:4:12)
at Changelog.createMarkdown (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:31:16)
at Object. (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/cli.js:77:64)
at makeError (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/lib/error.js:59:11)
at handlePromise (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/index.js:114:26)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async gatherChanges (file:///home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/release-plan/dist/gather-changes.js:8:20)
at async newChangelogContent (file:///home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/release-plan/dist/cli.js:78:19)
at async Object.handler (file:///home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/release-plan/dist/cli.js:14:36) {
shortMessage: 'Command failed with exit code 1: node /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/bin/cli.js --next-version Release',
command: 'node /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/bin/cli.js --next-version Release',
exitCode: 1,
signal: undefined,
signalDescription: undefined,
stdout: 'Error: Command failed with exit code 128: git describe --abbrev=0 --tags\n' +
'fatal: No names found, cannot describe anything.\n' +
' at makeError (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/lib/error.js:60:11)\n' +
' at module.exports.sync (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/index.js:194:17)\n' +
' at Object.lastTag (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/git.js:31:18)\n' +
' at Changelog. (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:32:56)\n' +
' at Generator.next ()\n' +
' at /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:8:71\n' +
' at new Promise ()\n' +
' at __awaiter (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:4:12)\n' +
' at Changelog.createMarkdown (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/changelog.js:31:16)\n' +
' at Object. (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/lib/cli.js:77:64)',
stderr: '',
failed: true,
timedOut: false,
isCanceled: false,
killed: false
}

We deduced it might be because there wasn't a previous github tag to compare against, so we added one but after adding a tag for the repo and rerunning the action manually we got this error instead:

release prepare

Edits the package.json and changelog files to prepare for release.

Options:
--version Show version number [boolean]
--help Show help [boolean]
--fromStdin Read the summary of changes from stdin instead of building
them from scratch. [boolean]
--singlePackage Allows you to run this command in a non monorepo and define
the package name [string]

Error: Command failed with exit code 1: node /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/bin/cli.js --next-version Release
Fetch error: Forbidden.
{"message":"Resource not accessible by integration","documentation_url":"[https://docs.github.com/rest/issues/issues#get-an-issue"}](https://docs.github.com/rest/issues/issues#get-an-issue%22%7D)
at makeError (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/lib/error.js:59:11)
at handlePromise (/home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/execa/index.js:114:26)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async gatherChanges (file:///home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/release-plan/dist/gather-changes.js:8:20)
at async newChangelogContent (file:///home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/release-plan/dist/cli.js:78:19)
at async Object.handler (file:///home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/[email protected]/node_modules/release-plan/dist/cli.js:14:36) {
shortMessage: 'Command failed with exit code 1: node /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/bin/cli.js --next-version Release',
command: 'node /home/runner/work/svelte-concurrency/svelte-concurrency/node_modules/.pnpm/@[email protected]/node_modules/@ef4/lerna-changelog/bin/cli.js --next-version Release',
exitCode: 1,
signal: undefined,
signalDescription: undefined,
stdout: 'Fetch error: Forbidden.\n' +
'{"message":"Resource not accessible by integration","documentation_url":"[https://docs.github.com/rest/issues/issues#get-an-issue"}](https://docs.github.com/rest/issues/issues#get-an-issue%22%7D)',
stderr: '',
failed: true,
timedOut: false,
isCanceled: false,
killed: false
}

It turns out the reason was that the repo we were setting it up on was private (and possibly has some Org settings we can't control). So I think it's worth adding to the readme that this can happen.

After making the repo public it worked like a charm! 🎉

Does the initial scaffold actually need the GITHUB_AUTH/TOKEN?

In the readme it says,

Obtain a GitHub personal access token.

but... why?

Thanks!!

CLI hangs when underlying dependency install goes interactive

I think the only way to solve this is to expose stdio: inherit?

thoughts?

Sometimes _a_ command needs to run before publish (due to a pnpm bug? idk)

scenario:

# .npmrc in the repo
ignore-scripts=true

then,

pnpm publish

and then prepack doesn't run 😩
which I believe is a bug, as ignore-scripts is not supposed to mean all scripts, and should actually be fixed in pnpm.
See also:

(this is about prepublishOnly, but it's "a" lifecycle hook -- ignore-scripts was only meant for install-based lifecycles, afaict)

idk if it makes sense to add a --build-command="pnpm build" to create-release-plan-setup?

like, this is what I've added for now: https://github.com/NullVoxPopuli/ember-data-resources/pull/408/files#diff-551d1fcf87f78cc3bc18a7b332a4dc5d8773a512062df881c5aba28a6f5c48d7R57

should we transfer to embroider-build (where release-plan lives?)

Been working on readme updates: embroider-build/release-plan#58 and was wondering if these tools should live in the same spot.

Delete `stderr.log` file again when empty?

E.g. this repo now has an empty stderr.log file as well:
https://github.com/embroider-build/create-release-plan-setup/blob/main/stderr.log

Or maybe it doesn't need to be part of the commit in the first place?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.