From b763a3bbfd2cf2cf4d64d9204c0624bebc9fb9e5 Mon Sep 17 00:00:00 2001 From: Georg Henzler Date: Mon, 8 Sep 2025 20:12:34 +0200 Subject: [PATCH 1/2] Initial commit --- .editorconfig | 13 ++ .github/ISSUE_TEMPLATE.md | 15 ++ .github/PULL_REQUEST_TEMPLATE.md | 36 +++++ .github/workflows/ci.yml | 31 ++++ .github/workflows/codeql-analysis.yml | 45 ++++++ .github/workflows/manual-release.yml | 75 ++++++++++ .github/workflows/release.yml | 44 ++++++ .gitignore | 32 ++++ .npmignore | 19 +++ .releaserc | 20 +++ LICENSE | 201 ++++++++++++++++++++++++++ README.md | 89 ++++++++++++ docs/CHANGELOG.md | 0 docs/CODE_OF_CONDUCT.md | 74 ++++++++++ docs/CONTRIBUTING.md | 25 ++++ package-lock.json | 5 + package.json | 21 +++ src/index.js | 1 + 18 files changed, 746 insertions(+) create mode 100644 .editorconfig create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/manual-release.yml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 .npmignore create mode 100644 .releaserc create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docs/CHANGELOG.md create mode 100644 docs/CODE_OF_CONDUCT.md create mode 100644 docs/CONTRIBUTING.md create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 src/index.js diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..aaaa30d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +root = true + +# Unix-style newlines with a newline ending every file +[*] +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +charset = utf-8 +indent_style = space +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..dc79395 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ + + +### Expected Behaviour + +### Actual Behaviour + +### Reproduce Scenario (including but not limited to) + +#### Steps to Reproduce + +#### Platform and Version + +#### Sample Code that illustrates the problem + +#### Logs taken while reproducing problem diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..856226c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## Description + + + +## Related Issue + + + + +Fixes # + +## 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: + + + +- [ ] My code follows the code style of this project. +- [ ] I have read the **[CONTRIBUTING](docs/CONTRIBUTING.mnd)** document. +- [ ] All new and existing tests passed. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..66a86b3 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,31 @@ +name: CI + +on: + push: + branches: [ '**' ] + pull_request: + branches: [ $default-branch ] + +jobs: + build: + + runs-on: ${{ matrix.os }} + + strategy: + matrix: + os: [ubuntu-latest] + node-version: [20.x] + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + - name: Install dependencies + run: npm ci + - name: Build Library + run: npm run build --if-present + - name: Run Tests + run: npm test --if-present diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..0bc5209 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,45 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '20 12 * * 0' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ 'javascript' ] + steps: + - name: Checkout + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + + - run: npm run build --if-present + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/manual-release.yml b/.github/workflows/manual-release.yml new file mode 100644 index 0000000..64790bd --- /dev/null +++ b/.github/workflows/manual-release.yml @@ -0,0 +1,75 @@ +name: Manual Release +on: + workflow_dispatch: + inputs: + version: + description: 'Version' + type: choice + required: true + default: fix + options: + - fix + - feat + - BREAKING CHANGE + dryRun: + description: 'DryRun' + type: boolean + default: true +# ENV and Config +env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + GIT_AUTHOR_NAME: github-actions + GIT_AUTHOR_EMAIL: github-actions@github.com + GIT_COMMITTER_NAME: github-actions + GIT_COMMITTER_EMAIL: github-actions@github.com + CI: true + CONFIG_NODE_VERSION: '["20.x"]' + CONFIG_OS: '["ubuntu-latest"]' +# Main Job +jobs: + config: + runs-on: ubuntu-latest + outputs: + NODE_VERSION: ${{ steps.set-config.outputs.CONFIG_NODE_VERSION }} + OS: ${{ steps.set-config.outputs.CONFIG_OS }} + steps: + - id: set-config + run: | + echo "CONFIG_NODE_VERSION=${{ toJSON(env.CONFIG_NODE_VERSION) }}" >> $GITHUB_OUTPUT + echo "CONFIG_OS=${{ toJSON(env.CONFIG_OS) }}" >> $GITHUB_OUTPUT + release: + name: Test, Build and force Release + needs: config + + runs-on: ${{ matrix.OS }} + strategy: + matrix: + OS: ${{ fromJSON(needs.config.outputs.OS) }} + NODE_VERSION: ${{ fromJSON(needs.config.outputs.NODE_VERSION) }} + + steps: + - name: Checkout repo + uses: actions/checkout@v4 + - name: Setup Node.js ${{ matrix.NODE_VERSION }} + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.NODE_VERSION }} + - name: Commit trigger + run: | + git commit --allow-empty -m "${{ github.event.inputs.version }}: Trigger Manual Release + + ${{ github.event.inputs.version }}:Forced Manual Release without code changes" + - name: Install dependencies + run: npm ci + - name: Build Library + run: npm run build --if-present + - name: Run Tests + run: npm test --if-present + - name: Publish npm package + uses: cycjimmy/semantic-release-action@v4 + with: + dry_run: ${{ github.event.inputs.dryRun == 'true' }} + extra_plugins: | + @semantic-release/changelog + @semantic-release/git diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..6bb5742 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,44 @@ +name: Release + +on: + push: + branches: + - main + +jobs: + release: + name: Test, Build and Release + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ ubuntu-latest ] + node-version: [ 20.x ] + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix['node-version'] }} + - name: Install dependencies + run: npm ci + - name: Build Library + run: npm run build --if-present + - name: Run Tests + run: npm test --if-present + - name: Release + uses: cycjimmy/semantic-release-action@v4 + with: + dry_run: true + extra_plugins: | + @semantic-release/changelog + @semantic-release/git + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + GIT_AUTHOR_NAME: github-actions + GIT_AUTHOR_EMAIL: github-actions@github.com + GIT_COMMITTER_NAME: github-actions + GIT_COMMITTER_EMAIL: github-actions@github.com + CI: true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..eccf3f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +# Logs +logs +*.log + +# IDE +.project +.classpath +.settings +.idea/ +*.iml* +*.ipr +.brackets.json +.vscode/ +.history + +# OS +.DS_Store +*.swp + +# Node related files +node_modules/ +node/ +bin/ +typings +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.stylelintcache +.eslintcache + +# env +\.env diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..64c44d6 --- /dev/null +++ b/.npmignore @@ -0,0 +1,19 @@ +.eslintrc +.nyc_output +rollup.config.js +.prettierrc +.git +.prettierignore +**/.git/ +**/node_modules/ +yarn.lock +/docs +/public +/coverage +/.vscode +/tests +/temp +.idea +.github +.releaserc +.editorconfig diff --git a/.releaserc b/.releaserc new file mode 100644 index 0000000..7c78d4c --- /dev/null +++ b/.releaserc @@ -0,0 +1,20 @@ +{ + "branches": ["main"], + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + [ + "@semantic-release/changelog", + { + "changelogFile": "docs/CHANGELOG.md" + } + ], + "@semantic-release/npm", + [ + "@semantic-release/git", + { + "assets": ["docs/CHANGELOG.md", "package.json"] + } + ] + ] +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a3aa46a --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [COMPANY] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f26a0a --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# npm-package-template + +Fully Automated NPM package release +- Automated semantic-release based on Angular Commit Message Conventions +- Manual release +- NPM release +- GitHub release +- GitHub Tags +- Changelog generation + +[![Version](https://img.shields.io/npm/v/@netcentric/npm-package-template.svg)](https://npmjs.org/package/@netcentric/npm-package-template) +[![Build Status](https://github.com/netcentric/npm-package-template/workflows/CI/badge.svg?branch=main)](https://github.com/netcentric/npm-package-template/actions) +[![CodeQL Analysis](https://github.com/netcentric/npm-package-template/workflows/CodeQL/badge.svg?branch=main)](https://github.com/netcentric/npm-package-template/actions) +[![semver: semantic-release](https://img.shields.io/badge/semver-semantic--release-blue.svg)](https://github.com/semantic-release/semantic-release) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +## TLDR; + +1. Create a new repo from this Template + [![Template repo](https://docs.github.com/assets/images/help/repository/use-this-template-button.png)](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) +2. Update the Readme + - replace `@netcentric/npm-package-template` with the new package_name +3. Update package.json + - replace "name" `@netcentric/npm-package-template` with the new package_name + - replace "repository.url" `https://github.com/netcentric/npm-package-template` with the new repository url + - Add description, and other fields if needed +4. Update LICENSE + - Update `[COMPANY]` name + - Update year `[yyyy]` +5. Update docs/CODE_OF_CONDUCT.md + - Update `[COMPANY]` name +6. Activate automatic release + - disable `dry_run` in Release step in .github/workflows/release.yml. + +## Content + +### Docs + - LICENSE + - docs/CODE_OF_CONDUCT.md + - docs/CONTRIBUTING.md + - docs/CHANGELOG.md --> dynamically updated + +### Issue template + - .github/ISSUE_TEMPLATE.md + +### PR template + - .github/PULL_REQUEST_TEMPLATE.md --> automatically closes connected issue + +### Workflows + - CI --> npm ci, test and build + - CodeQL --> Perform CodeQL Analysis (Security, etc.) + - Release --> semantic-release: + * Creates release notes + * Updates CHANGELOG + * Updates package.json version + * Creates Git tag/release + * Publish package to NPM + - Manual Release --> same as Release, but can be triggered manually in Actions tab + +### Release + - based on Angular Commit Message Conventions in commits - + https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-header + - Commit message format is used to build: + * Release notes + * Changelog updates + * NPM package semver + +### Commit message Convention + +``` +(): +│ │ │ +│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. +│ │ +│ └─⫸ Commit Scope (optional): project|based|list +│ +└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test +``` + + +#### Major Version Release: + +In order to trigger Major Version upgrade, `BREAKING CHANGE:` needs to be in the footer of a commit message: + +``` +(): + +BREAKING CHANGE: +``` diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3526918 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# [COMPANY] Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at Grp-opensourceoffice@adobe.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..772f4c1 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +Thanks for choosing to contribute! + +The following are a set of guidelines to follow when contributing to this project. + +## Code Of Conduct + +This project adheres to the [code of conduct](CODE_OF_CONDUCT.md). By participating, +you are expected to uphold this code. + +## Have A Question? + +Start by filing an issue. The existing committers on this project work to reach +consensus around project direction and issue solutions within issue threads +(when appropriate). + +## Code Reviews + +All submissions should come in the form of pull requests and need to be reviewed +by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/) +for more information on sending pull requests. + +Lastly, please follow the [pull request template](../.github/PULL_REQUEST_TEMPLATE.md) when +submitting a pull request! diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..95f2aba --- /dev/null +++ b/package-lock.json @@ -0,0 +1,5 @@ +{ + "name": "@netcentric/npm-package-template", + "version": "1.0.0", + "lockfileVersion": 1 +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..44f54e6 --- /dev/null +++ b/package.json @@ -0,0 +1,21 @@ +{ + "name": "@netcentric/npm-package-template", + "version": "1.0.0", + "description": "NPM Package Automation Template", + "license": "Apache-2.0", + "private": false, + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "https://github.com/netcentric/npm-package-template" + }, + "main": "src/index.js", + "scripts": { + "test": "echo \"Error: no test specified\"" + }, + "keywords": [ + "npm automation" + ] +} diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..e0065a4 --- /dev/null +++ b/src/index.js @@ -0,0 +1 @@ +console.log('main index file'); From 3c491ee30309c6c11025835eb102566a3b24baf1 Mon Sep 17 00:00:00 2001 From: Oleksandr Tarasenko Date: Thu, 26 Mar 2026 18:55:01 +0100 Subject: [PATCH 2/2] ci: fix codeql step --- .github/workflows/codeql-analysis.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 0bc5209..9bc6eab 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -39,7 +39,5 @@ jobs: with: languages: ${{ matrix.language }} - - run: npm run build --if-present - - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v3