feat: include default nunjucks filters and new release to the generator #1225

ayushnau · 2024-06-27T21:00:08Z

Changes Added.

Added the new Release with changesets.

Related issue(s)

Related to: #1044

chore(release): 1.0.0

Bumps [npm](https://github.com/npm/cli) from 6.14.4 to 6.14.6. - [Release notes](https://github.com/npm/cli/releases) - [Changelog](https://github.com/npm/cli/blob/latest/CHANGELOG.md) - [Commits](npm/cli@v6.14.4...v6.14.6) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.15...4.17.19) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

chore(release): 1.1.0

Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. - [Release notes](https://github.com/bitinn/node-fetch/releases) - [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md) - [Commits](node-fetch/node-fetch@v2.6.0...v2.6.1) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

chore(deps-dev): bump semantic-release from 17.0.6 to 17.2.3

ci: update global workflows

chore(deps): bump ini from 1.3.5 to 1.3.7

ci: update global workflows

Co-authored-by: asyncapi-bot <[email protected]>

ci: update global workflows

Bumps [y18n](https://github.com/yargs/y18n) from 3.2.1 to 3.2.2. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Co-authored-by: asyncapi-bot <[email protected]>

Merge branch 'master' of github.com:ayushnau/generator

.changeset/wise-laws-retire.md

README.md

derberg · 2024-07-25T16:22:25Z

README.md

+   - Push your changes and open a Pull Request (PR). The changeset file helps communicate the type of changes (major, minor, patch).
+
+3. **CI Processes Changeset**:
+   - During the CI/CD pipeline, the following `changesets/action` step runs:


no need to provide content of the workflow, just explanation

derberg · 2024-07-25T16:23:36Z

README.md

+
+   - The new PR will also contain the description from the markdown files.
+
+4. **Merge the Versioning PR**:


versioning PR? isn't it also a release triggering PR?

derberg · 2024-07-25T16:24:30Z

README.md

+   - Once the versioning PR is created, it should be merged (automatically by the bot in this case).
+
+5. **Release the Package**:
+   - After the PR is merged, the CI/CD pipeline runs again. The `changesets/action` step detects that the PR was created by itself and runs the `publish` command to release the package.


can you specify basing on what conditions this happens?

derberg · 2024-07-25T16:26:57Z

README.md

+
+- Custom filters. Check out [API docs](apps/nunjucks-filters/docs/api.md) for complete list
+- Lodash-powered filters. For the list of all available filters check [official docs](https://lodash.com/docs/)
+
 ## Contributing


this section should stay as it was

all below steps should be in a separate section like ## Release process

derberg · 2024-07-25T16:27:30Z

README.md

 ## Contributing

+To Add a major/minor/patch Type Changes:


what about conventional commits, they are still used right?

simply specify that we use conventional commits to have a clear git history of commits and so we can quickly figure out what given commit changed, and if it was release triggering

that feat and fix prefixes are needed to trigger changeset

.github/workflows/release-with-changesets.yml

lmgyuan · 2024-07-25T17:22:14Z

README.md

+
+1. [Generator](apps/generator): This is a tool that you can use to generate whatever you want basing on the AsyncAPI specification file as an input.
+
+2. [Generator-filters](apps/nunjucks-filters): This library contains generator filters that can be reused across multiple templates, helping to avoid redundant work. These filters are designed specifically for Nunjucks templates and are included by default with the generator, so there's no need to add then to  dependencies seprately.


"no need to add them to dependencies seprately." instead of "no need to add then to dependencies seprately."

lmgyuan · 2024-07-25T17:22:48Z

README.md

+
+2. [Generator-filters](apps/nunjucks-filters): This library contains generator filters that can be reused across multiple templates, helping to avoid redundant work. These filters are designed specifically for Nunjucks templates and are included by default with the generator, so there's no need to add then to  dependencies seprately.
+
+
 ![npm](https://img.shields.io/npm/v/@asyncapi/generator?style=for-the-badge) ![npm](https://img.shields.io/npm/dt/@asyncapi/generator?style=for-the-badge)

 > :warning: This package doesn't support AsyncAPI 1.x anymore. We recommend to upgrade to the latest AsyncAPI version using the [AsyncAPI converter](https://github.com/asyncapi/converter-js). If you need to convert documents on the fly, you may use the [Node.js](https://github.com/asyncapi/converter-js) or [Go](https://github.com/asyncapi/converter-go) converters.


Delete the first ":" before warning

"This package doesn't support AsyncAPI 1.x anymore. We recommend to upgrade to the latest AsyncAPI version using the AsyncAPI converter (you can refer to this installation guide)." instead of "This package doesn't support AsyncAPI 1.x anymore. We recommend to upgrade to the latest AsyncAPI version using the AsyncAPI converter."

lmgyuan · 2024-07-25T17:34:36Z

README.md


 <!-- TEMPLATES-LIST:END -->

 You can find above templates and the ones provided by the community in **[this list](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)**

+# Generator Filters
+
+This library contains generator filters that can be reused across multiple templates, helping to avoid redundant work. These filters are designed specifically for Nunjucks templates and are included by default with the generator, so there's no need to add then to  dependencies seprately.


" so there's no need to add them to dependencies seprately."
instead of
" so there's no need to add then to dependencies seprately."

Co-authored-by: Lukasz Gornicki <[email protected]>

ayushnau · 2024-07-25T18:33:05Z

@derberg @lmgyuan please check made all the required changes.

ayushnau · 2024-07-29T07:02:21Z

@derberg @lmgyuan please check the pr.

sonarcloud · 2024-07-29T11:15:09Z

Quality Gate passed

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

derberg · 2024-07-29T11:41:54Z

/rtm

derberg and others added 30 commits April 17, 2020 15:42

Initial commit

7a5f64e

feat: introduce filters library (#1)

dacb1f7

fix: ignore lint for one function and add workflow to test PRs (#4)

0dc43f9

chore(release): 1.0.0 (#5)

6921a76

chore(release): 1.0.0

feat: Support circular refs in generateExample filter (#7)

575a0c6

chore(release): 1.1.0 (#10)

b20080a

chore(release): 1.1.0

refactor: Remove unnecessary semicolons from custom filters (#13)

dddc03b

ci: Cleanup GitHub Actions workflows (#14)

0680c43

chore(deps-dev): bump semantic-release from 17.0.6 to 17.2.3 (#15)

eaec55f

chore(deps-dev): bump semantic-release from 17.0.6 to 17.2.3

ci: update global workflows (#16)

595904b

ci: update global workflows

ci: add automated bump workflow and improve pr testing (#17)

e97436d

chore(deps): bump ini from 1.3.5 to 1.3.7 (#18)

147a943

chore(deps): bump ini from 1.3.5 to 1.3.7

ci: update global workflows (#19)

2a2cf5d

ci: update global workflows

ci: fix the space-issue in bump workflow (#20)

8670cd8

ci: remove release and pr testing workflows to use the gobal ones (#21)

36e9738

ci: update global workflows (#22)

689ac37

ci: update global workflows

ci: update global workflows (#23)

84f8ccf

ci: update global workflows

ci: update global workflows (#24)

4e83050

ci: update global workflows

ci: update global workflows (#25)

43c69c3

ci: update global workflows

ci: update global workflows (#26)

a6215ab

Co-authored-by: asyncapi-bot <[email protected]>

chore: change linebreak style to 0 (#27)

08772d6

ci: update global workflows (#28)

4a9f35c

ci: update global workflows

ci: update global workflows (#29)

427f053

ci: update global workflows

ci: update global workflows (#31)

27c345f

Co-authored-by: asyncapi-bot <[email protected]>

ci: update global workflows (#32)

ef6fd68

Co-authored-by: asyncapi-bot <[email protected]>

chore(deps): bump handlebars from 4.7.6 to 4.7.7

9d7d282

:q

45122ae

Merge branch 'master' of github.com:ayushnau/generator

derberg changed the title ~~feat: introduce the generator filters and new release to the generator.~~ feat: include default nunjucks filters and new release to the generator Jul 25, 2024

derberg reviewed Jul 25, 2024

View reviewed changes

.changeset/wise-laws-retire.md Outdated Show resolved Hide resolved

derberg and others added 4 commits July 25, 2024 17:59

Update .changeset/wise-laws-retire.md

89c6f91

updated the filters documentation.

490c17f

Merge branch 'master' of github.com:ayushnau/generator

85dfcd4

updated nunjucks.render-engine.md

98b2c19

derberg reviewed Jul 25, 2024

View reviewed changes

Update release-with-changesets.yml

95a460b

derberg reviewed Jul 25, 2024

View reviewed changes

.github/workflows/release-with-changesets.yml Show resolved Hide resolved

lmgyuan reviewed Jul 25, 2024

View reviewed changes

ayushnau and others added 7 commits July 25, 2024 23:20

Update README.md

fa6440d

Co-authored-by: Lukasz Gornicki <[email protected]>

Update README.md

34fc188

Co-authored-by: Lukasz Gornicki <[email protected]>

Update README.md

a3bb388

Co-authored-by: Lukasz Gornicki <[email protected]>

Update README.md

516471f

Co-authored-by: Lukasz Gornicki <[email protected]>

Update README.md

948e73d

Co-authored-by: Lukasz Gornicki <[email protected]>

Update .github/workflows/release-with-changesets.yml

da9dc4e

Co-authored-by: Lukasz Gornicki <[email protected]>

upated Readmd.md

376d63a

derberg added 3 commits July 29, 2024 12:45

added even more details about the releasae

7afe272

some final edits to readme

4a2306c

we should lock on specific version when using npx

45b9818

derberg approved these changes Jul 29, 2024

View reviewed changes

asyncapi-bot added the ready-to-merge label Jul 29, 2024

asyncapi-bot merged commit 99a14a8 into asyncapi:master Jul 29, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: include default nunjucks filters and new release to the generator #1225

feat: include default nunjucks filters and new release to the generator #1225

ayushnau commented Jun 27, 2024 •

edited

Loading

derberg Jul 25, 2024

ayushnau Jul 25, 2024

derberg Jul 25, 2024

ayushnau Jul 25, 2024

derberg Jul 25, 2024

ayushnau Jul 25, 2024

derberg Jul 25, 2024

ayushnau Jul 25, 2024

derberg Jul 25, 2024

derberg Jul 25, 2024

ayushnau Jul 25, 2024

lmgyuan Jul 25, 2024

ayushnau Jul 25, 2024

lmgyuan Jul 25, 2024

lmgyuan Jul 25, 2024 •

edited

Loading

ayushnau Jul 25, 2024

lmgyuan Jul 25, 2024

ayushnau Jul 25, 2024

ayushnau commented Jul 25, 2024

ayushnau commented Jul 29, 2024

sonarcloud bot commented Jul 29, 2024

derberg commented Jul 29, 2024


		- The new PR will also contain the description from the markdown files.

		4. Merge the Versioning PR:


		1. [Generator](apps/generator): This is a tool that you can use to generate whatever you want basing on the AsyncAPI specification file as an input.

		2. [Generator-filters](apps/nunjucks-filters): This library contains generator filters that can be reused across multiple templates, helping to avoid redundant work. These filters are designed specifically for Nunjucks templates and are included by default with the generator, so there's no need to add then to dependencies seprately.

feat: include default nunjucks filters and new release to the generator #1225

feat: include default nunjucks filters and new release to the generator #1225

Conversation

ayushnau commented Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lmgyuan Jul 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayushnau commented Jul 25, 2024

ayushnau commented Jul 29, 2024

sonarcloud bot commented Jul 29, 2024

Quality Gate passed

derberg commented Jul 29, 2024

ayushnau commented Jun 27, 2024 •

edited

Loading

lmgyuan Jul 25, 2024 •

edited

Loading