From 7210a2982e035e7fed006c501562fcb3ba742d61 Mon Sep 17 00:00:00 2001 From: Luis Majano Date: Mon, 22 Apr 2024 10:12:58 +0200 Subject: [PATCH] template ready --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/release.yml | 4 ++-- .github/workflows/snapshot.yml | 2 +- .github/workflows/tests.yml | 2 +- CONTRIBUTING.md | 4 ++-- box.json | 14 +++++++------- readme.md | 2 +- settings.gradle | 2 +- src/build/SetupTemplate.cfc | 6 +++--- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4af474a..a991c46 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,7 +11,7 @@ IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for deta All PRs must have an accompanied Jira issue. Please make sure you created it and linked it here. BoxLang Jira: https://ortussolutions.atlassian.net/browse/BL/issues -Module Issues: https://github.com/boxlang-modules/@MODULE_SLUG@/issues +Module Issues: https://github.com/boxlang-modules/bx-pdf/issues ## Type of change diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f8ca2b9..79c31f6 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,6 +1,6 @@ # This workflow is used to build releases # It can also be called by other workflows to reuse the release flow. -name: @MODULE_NAME@ Release +name: BoxLang PDF Module Release on: # If you push to main this will trigger a stable release @@ -19,7 +19,7 @@ on: type: boolean env: - MODULE_ID: @MODULE_SLUG@ + MODULE_ID: bx-pdf SNAPSHOT: ${{ inputs.snapshot || false }} JDK: 17 GRADLE: 8.7 diff --git a/.github/workflows/snapshot.yml b/.github/workflows/snapshot.yml index d3f410c..c31a07d 100644 --- a/.github/workflows/snapshot.yml +++ b/.github/workflows/snapshot.yml @@ -1,4 +1,4 @@ -name: @MODULE_NAME@ Snapshots +name: BoxLang PDF Module Snapshots on: push: diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 80e5e2a..71b335f 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,4 +1,4 @@ -name: @MODULE_NAME@ Test Suites +name: BoxLang PDF Module Test Suites # We are a reusable Workflow only on: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 600f181..bb1712f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# @MODULE_NAME@ Contributing Guide +# BoxLang PDF Module Contributing Guide Hola amigo! I'm really excited that you are interested in contributing to our BoxLang Module. Before submitting your contribution, please make sure to take a moment and read through the following guidelines: @@ -30,7 +30,7 @@ This project is open source, and as such, the maintainers give their free time t BoxLang tracks its issues in Jira and each module track it's own issues in its repo. - BoxLang JIra : https://ortussolutions.atlassian.net/browse/BL/issues -- Module Issues: https://github.com/boxlang-modules/@MODULE_SLUG@/issues +- Module Issues: https://github.com/boxlang-modules/bx-pdf/issues If you file a bug report, your issue should contain a title, a clear description of the issue, a way to replicate the issue, and any support files that we might need to replicate your issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix for it. All issues that do not contain a way to replicate will not be addressed. diff --git a/box.json b/box.json index ce34410..e37c9d0 100644 --- a/box.json +++ b/box.json @@ -1,16 +1,16 @@ { - "name":"@MODULE_NAME@", + "name":"BoxLang PDF Module", "version":"@build.version@+@build.number@", - "location" : "https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/@MODULE_SLUG@/@build.version@/@MODULE_SLUG@-@build.version@.zip", + "location" : "https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-pdf/@build.version@/bx-pdf-@build.version@.zip", "author":"Ortus Solutions", - "homepage":"https://github.com/boxlang-modules/@MODULE_SLUG@", - "documentation":"https://github.com/boxlang-modules/@MODULE_SLUG@", + "homepage":"https://github.com/boxlang-modules/bx-pdf", + "documentation":"https://github.com/boxlang-modules/bx-pdf", "repository":{ "type":"git", - "URL":"https://github.com/boxlang-modules/@MODULE_SLUG@" + "URL":"https://github.com/boxlang-modules/bx-pdf" }, - "bugs":"https://github.com/boxlang-modules/@MODULE_SLUG@/issues", - "slug":"@MODULE_SLUG@", + "bugs":"https://github.com/boxlang-modules/bx-pdf/issues", + "slug":"bx-pdf", "shortDescription":"Module template for BoxLang modules", "type":"boxlang-modules", "keywords":[ diff --git a/readme.md b/readme.md index d8be640..74c950a 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# ⚡︎ BoxLang Module: @MODULE_NAME@ +# ⚡︎ BoxLang Module: BoxLang PDF Module ``` |:------------------------------------------------------:| diff --git a/settings.gradle b/settings.gradle index 1ec5476..49af538 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,2 @@ // The name of the module -rootProject.name = '@MODULE_SLUG@' +rootProject.name = 'bx-pdf' diff --git a/src/build/SetupTemplate.cfc b/src/build/SetupTemplate.cfc index ca18f24..c2e043a 100644 --- a/src/build/SetupTemplate.cfc +++ b/src/build/SetupTemplate.cfc @@ -39,7 +39,7 @@ component { command( "tokenReplace" ) .params( path = "/#variables.cwd#/**", - token = "@MODULE_NAME@", + token = "BoxLang PDF Module", replacement = moduleName ) .run(); @@ -47,7 +47,7 @@ component { command( "tokenReplace" ) .params( path = "/#variables.cwd#/**", - token = "@MODULE_SLUG@", + token = "bx-pdf", replacement = moduleSlug ) .run(); @@ -55,7 +55,7 @@ component { command( "tokenReplace" ) .params( path = "/#variables.cwd#/**", - token = "@MODULE_DESCRIPTION@", + token = "A collection of PDF BIFS, components and more", replacement = moduleDescription ) .run();