Skip to content

Conversation

Smankusors
Copy link
Member

Proposed changes

Releasing 1.1.0, also

  • with the CHANGELOG now generated by github_changelog_generator
    • sorry @ChildishGiant, do you manually write the CHANGELOG or is it generated? If it's generated, I can't find which one you are using 🙏
    • this CHANGELOG will be used for release notes later
    • should every PR be included? Or other PRs with "meta" label should be excluded?
    • let me know how it looks like, feedbacks are welcome
  • update package-lock.json file version
    • because I used node 16

Screenshots (if appropriate) or codepen:

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist:

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Additional contexts for CHANGELOG

Here's how I run the github_changelog_generator

docker run -it --rm \
  -v "$(pwd)":/usr/local/src/your-app \
  githubchangeloggenerator/github-changelog-generator \
  -u materializecss \
  -p materialize \
  --base dontusehistorypls.md \
  --since-tag 1.0.0 \
  --token [insert token here] \
  --no-issues \
  --future-release 1.1.0 \
  --bug-labels bug,bugfix \
  --breaking-labels "breaking changes" \
  --add-section '{"docs":{"labels":["documentation"],"prefix":"**Documentation changes:**"},"meta":{"labels":["build","meta"],"prefix":"**Meta changes:**"}}'

After that, I manually inspect what is missing. Seems like some PRs is missing because its commit can't be found on the main branch.

* with the CHANGELOG now generated by github_changelog_generator
* update package-lock.json file version
   * because I used node 16
* more changes after running npm run release
@Smankusors Smankusors added the meta Issues with the project itself or our GitHub repository. label Apr 9, 2022
@Smankusors Smankusors requested a review from a team April 9, 2022 15:49
@Smankusors
Copy link
Member Author

Thanks everyone for the reviews. I will proceed to release the 1.1.0 now

@Smankusors Smankusors merged commit 330502e into materializecss:main Apr 20, 2022
@Smankusors
Copy link
Member Author

oh goddamn. I forgot to push the package-lock.json to this PR after changing the version from 1.1.0-alpha to 1.1.0 🤦

@DanielRuf
Copy link

oh goddamn. I forgot to push the package-lock.json to this PR after changing the version from 1.1.0-alpha to 1.1.0 🤦

No problem since lockfiles are not consumed / used when installing packages from npmjs.
Only the local lockfiles in projects are used.

@DanielRuf
Copy link

https://dev.to/gajus/stop-using-package-lock-json-or-yarn-lock-3ddi

Committing package-lock.json to the source code version control means that the project maintainers and CI systems will use a specific version of dependencies that may or may not match those defined in package.json. Because package-lock.json cannot be added to NPM registry (by design; see NPM shrinkwrap), projects that depend on a project that uses package-lock.json will themselves use package.json to resolve project's dependencies, i.e. what works for project maintainers/ CI systems might not work when the project is used as a dependency.

The origin of this misuse is NPM documentation. It should instead explain that package-lock.json should only be committed to the source code version control when the project is not a dependency of other projects, i.e. package-lock.json should only by committed to source code version control for top-level projects (programs consumed by the end user, not other programs).

npm/npm#20603

@Smankusors Smankusors removed the meta Issues with the project itself or our GitHub repository. label Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants