geut / chan Goto Github PK

If this had a merge driver for git to automatically resolve merge conflicts, that would be great.

Research about services for NPM badge supporting scoped packages.

• https://badge.fury.io/ ?

A coworker of mine added the following sub section in the Unreleased section:

### New environment variables

bla bla bla bla bla bla

Whenever I tried to run a command, the command would fail with:

The name prop to create an action is not valid

Would it be possible to accept sections that are not know to the tool, and blindly copy them when releasing?

Thank you

We should run the lint action as part of npm t. This should help us enforce the linting without necessarily adding a precommit lint step.

We use a self hosted instance of GitLab at my office, and as such, the URLs that get generated by chan don't adhere to the URL structure required by GitLab.

For example, chan might output a URL like:

https://git.example.com/:weblinx/my-repository/compare/v1.0.0...HEAD

But my server actually requires:

https://git.example.com/weblinx/my-repository/compare/v1.0.0...master

Being able to pass in something like --compare master (preferably also via config file) would solve this.

Hello,

When I try to run a chan xxx on an legacy changelog, I can't due to an error.

Here is an example of my changelog.md:

The link keepachangelog.com in the readme is taking me to https://github.com/geut/chan/blob/master/1 instead of the properly url.

Hello! I appreciate the work you've put into this tool. It's very straightforward to use and much less opinionated and forceful than other tools I've found.

I have a request for a feature though, which is allowing for chan returning a non-zero exit code if it runs into an error.

Current Behavior

 λ chan release 0.1.3
[chan] [release] › ✖  error     There are not new changes to release.
 λ echo $?
0

Desired behavior

 λ chan release 0.1.3
[chan] [release] › ✖  error     There are not new changes to release.
 λ echo $?
1 # or other exit code

This is primarily for use in scripting/CI where I want to not continue if there was an error in running chan.

I do not use js typically, but I might be willing to attempt a PR if you'd like.

Hi. Today geut/chan when prints version headers don't use brackets around the version number. Following the example of keep-a-changelog it uses brackets and some tools use this to parse the CHANGELOG to get the release notes, like release-it. What do you think about we start to put the brackets around the version number?

today

## 0.0.1 - 2000-01-01

suggested

## [0.0.1] - 2000-01-01

This is what happens in release-it when we don't have the brackets around the version number in github release notes. It get all the changelog instead stop in the last notes.

We need to detect the git repo for Github, Gitlab and Bitbucket and create the git-compare url automatically.

Create a monorepo structure with Lerna + npm: move chan to packages.

📜 For chan CLI we can re-use the same root readme that we currently have. For the other packages, we need to write every new readme file.

Every time i run a chan command (fixed, added, whatever) i get this error:

[chan] [removed] › ✖  error     The `identifier` of the release is required.

here is my CHANGELOG.md

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.2.0] - 2021-11-03
### Fixed 
- Fixed Two deprecation warnings for _normalize-mixin.scss 

### Changed
- Replaced normalize.scss with a cdn link to normalize.css
## [0.1.2] - 2021-08-21
### Changed
- There is no css files anymore, all the css is generated from scss, except for the hugo-tufte-override.css of course (70c7b91) [#15](https://github.com/slashformotion/hugo-tufte/issues/15)

### Fixed
- An icon wasn't showing in the navbar menu (c8bc5f6) [#26](https://github.com/slashformotion/hugo-tufte/issues/26)

### Deprecated
- Some parts of Feather.js support remained in the code, they are now removed. (472bb3d) [#32](https://github.com/slashformotion/hugo-tufte/issues/32)
## [0.1.1] - 2021-08-15
### Added
- Markdown styling support in the following shortcodes 
    - `marginnote` (4e38a13) [#18](https://github.com/slashformotion/hugo-tufte/issues/18)
    - `blockquote` (628637b) [#20](https://github.com/slashformotion/hugo-tufte/issues/20)
    - `epigraph` (628637b) [#20](https://github.com/slashformotion/hugo-tufte/issues/20)
    - `newthought` (628637b) [#20](https://github.com/slashformotion/hugo-tufte/issues/20)
    - `sidenote` (628637b) [#20](https://github.com/slashformotion/hugo-tufte/issues/20)

### Note
- The link to the repo in the footer is now pointing at https://github.com/slashformotion/hugo-tufte (ccb1ac0) [#22](https://github.com/slashformotion/hugo-tufte/issues/22)
## [0.1.0] - 2021-08-14
### Added
- All of the [Tufte-css](https://github.com/edwardtufte/tufte-css) feature via [shortcodes](https://github.com/slashformotion/hugo-tufte#shortcodes). 
- Support out of the box for social media links( github, gitlab, twitter, patreon, youtube, medium, reddit, stackoverflow, instagram, mastodon, orcid, google_scholar).
- Support for custom navbar and footer links.
- Support for  mathematical typesetting (LaTex) support via [katex](https://katex.org/) or [MathJax](https://www.mathjax.org). 

[Unreleased]: https://github.com/slashformotion/hugo-tufte/compare/v0.2.0...HEAD
[0.1.2]: https://github.com/slashformotion/hugo-tufte/releases/tag/v0.2.0
[0.1.2]: https://github.com/slashformotion/hugo-tufte/releases/tag/v0.1.2
[0.1.1]: https://github.com/slashformotion/hugo-tufte/releases/tag/v0.1.1
[0.1.0]: https://github.com/slashformotion/hugo-tufte/releases/tag/v0.1.0

looks like it comes from here:

I tried to understand what is going on but I don't know javascript, so...yeah..i'm stuck on this one

I was testing out the latest beta release, and found that I can set the configuration option get-template in package.json, but not in .chanrc. Documentation seems to indicate either should work. https://github.com/geut/chan/issues/new

Make a YANKED release to be forced by a parameter to avoid a release with no changes by mistake.

Hi All ,
Im trying to use chan for changelog , all the commands are working perfectly till i enter "chan release 1.0.0.1" , the error "Chan: The url must be a string." is raised .
Any help please

This is what I write in the text editor when calling chan added:

The following code block will be lost:
```
Hello world
```
This one too:

        Goodbye World

This is what gets created:

## [Unreleased]
### Added
- The following code block will be lost:
      Hello world
  This one too:
          Goodbye World

Now when I call chan added again and create a new entry whose content is Some stuff., this is the resulting changelog:

## [Unreleased]
### Added
- The following code block will be lost:
  Hello world
  This one too:
  Goodbye World
- Some stuff.

By that point, code blocks are no more.

closed by #23

In version 1.3.0-0 the default export is chan which includes access to the api for init, changes, release, etc.
Document changes in Readme.

I keep getting the below error when trying to generate a release, using any version number on a new project... steps to reproduce:

1. echo '{ "git-template": "https://gitlab.com/namespace/project/compare/[prev]...[next]" }' > .chanrc
2. chan init
3. chan changed "Some message"
4. chan release 0.1.0

Command: chan release <semver>

Chan is going to ignore the prerelease (like v2.0.0-beta1) by default.

We are going to have two new options:

• --prerelease is going to allow prerelease versions.
• --merge-prerelease is going to allow prereleases and merge them on the next official release.

My company uses a self-hosted GitLab server to store our code. When I have my origin set to a repository on our GitLab server, I get the following error when runing chan release ${npm_package_version}:

[chan] [release] › ✖  error     TypeError: Cannot destructure property `template` of 'undefined' or 'null'.

I think this might only be used for the first release (since other links show the changes between the newly released tag and its previous tag).

Code:

Reference for GitHub tag url:
https://github.com/geut/chan/releases/tag/v3.2.1

The cli is going to be the @geut/chan module.

For example, if I have this in my CHANGELOG.md:

## [Unreleased]
### Added
- One last item for demo

## [0.5.0-a2] - 2019-07-22
### Added
- Hello world

## [0.5.0-a1] - 2019-07-21
### Added
- Testing something

The output when running chan release 0.5.0 --merge-prelease is:

## [0.5.0] - 2019-07-22
### Added
- One last item for demo

### Added
- Hello world
- Testing something

As you can see, the unreleased items under "Added" aren't being merged with the two prerelease "Added" headers. This could be worked around by first create a prerelease 0.5.0-a3 or something, but that seems unnecessary to me.

Executing chan added '...' in node v12 I get the error:

internal/process/esm_loader.js:74
    internalBinding('errors').triggerUncaughtException(
                              ^

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'fs' imported from /home/tincho/projects/geut/nanocontext/node_modules/@geut/chan/src/commands/init.js
    at packageResolve (internal/modules/esm/resolve.js:650:9)
    at moduleResolve (internal/modules/esm/resolve.js:691:18)
    at Loader.defaultResolve [as _resolve] (internal/modules/esm/resolve.js:784:11)
    at Loader.resolve (internal/modules/esm/loader.js:100:40)
    at Loader.getModuleJob (internal/modules/esm/loader.js:246:28)
    at ModuleWrap.<anonymous> (internal/modules/esm/module_job.js:47:40)
    at link (internal/modules/esm/module_job.js:46:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}

The error is related to being imported fs by 'fs/promises' since node v12 doesn't have that feature.

Hi,

I use chan for lot of projects on github and it's work perfectly !
But I have some other projects on gitlab and currenctly I can't directly create release on it using chan.
This feature is already planned ?
Else I think it can be very cool to have a gitlab-release command.

I think the only difference is the intro text:

chan uses:

# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

I want to tie in to chan to also update my composer.json and some other elements; I can do this by writing my own scripts, but I'm not finding any information about those kinds of hooks. Is this possible?

Not sure what's happening here, but when I run a command like chan release 1.0.0, the URLs that get output are like so:

https://github.com/:JacobDB/pwa-install-prompt/compare/v1.0.0...HEAD

As you can see, there's a : just before my username, and thus when you try to visit the URL, you get a message "Not found."

The package.json for the project I was testing on is available here.

Hi there!

This week, I started running into an error with every chan command I ran. This includes chan added, chan fixed, chan release, and chan gh-release.

The error is always the same: "The identifier of the release is required."

I've been using chan for many months now and have never run into issues before this one. I've tried downgrading to previous versions with no success. I haven't changed anything about my typical flow when using chan.

Any idea what could be causing this or how to get past it? Or is this a known issue?

Sorry for the noise 😢 , I'm just trying to get chan set up in GitHub Actions with a project I'm managing and I'm running into small issues.

Current behavior

 λ unset GITHUB_TOKEN
 λ chan gh-release 0.1.3
[chan] [gh-release] › ℹ  info      Uploading GitHub release...

 λ export GITHUB_TOKEN=<REDACTED>
 λ chan gh-release 0.1.3
[chan] [gh-release] › ℹ  info      Uploading GitHub release...
[chan] [gh-release] › ✖  error     TypeError: Cannot read property 'createRelease' of undefined
    at createGithubRelease (file:///Users/mbianchi/workspace/dev/dotfiles/config/yarn/global/node_modules/@geut/chan/src/commands/gh-release.js:84:26)
    at Object.handler (file:///Users/mbianchi/workspace/dev/dotfiles/config/yarn/global/node_modules/@geut/chan/src/commands/gh-release.js:55:9)

The usage of GITHUB_TOKEN is causing an error of the createRelease command, though I can't figure out why. The usage in gh-release looks correct, but maybe something isn't set properly in the data object.