Package Health Score

59 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.9.0	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.8.0	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.8.2	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.0	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.2	\|	12/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (198)

GitHub Stars: 2
Forks: 7
Contributors: 20

Direct Usage Popularity

The npm package screwdriver-template-main receives a total of 198 downloads a week. As such, we scored screwdriver-template-main popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package screwdriver-template-main, we found that it has been starred 2 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the screwdriver-template-main repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 9 months ago
Last Commit: 9 months ago

Further analysis of the maintenance status of screwdriver-template-main based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that screwdriver-template-main demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18.0.0

Age: 8 years
Dependencies: 3 Direct
Versions: 37
Install Size: 53.9 kB
Dist-tags: 1
# of Files: 23
Maintainers: 10
TS Typings: No

screwdriver-template-main has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

template-main

Downloads License

Validates and publishes templates

Usage

npm install screwdriver-template-main

Create a Screwdriver pipeline with your template repo and start the build to validate and publish it.

To update a Screwdriver template, make changes in your SCM repository and rerun the pipeline build.

Validating a template

Run the template-validate script. By default, the path ./sd-template.yaml will be read. However, a user can specify a custom path using the env variable: SD_TEMPLATE_PATH.

Example screwdriver.yaml:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - install: npm install screwdriver-template-main
            - validate: ./node_modules/.bin/template-validate
        environment:
            SD_TEMPLATE_PATH: ./path/to/template.yaml

template-validate can print a result as json by passing --json option to the command.

$ ./node_modules/.bin/template-validate --json
{"valid":true}

Publishing a template

Run the template-publish script. By default, the path ./sd-template.yaml will be read. However, a user can specify a custom path using the env variable: SD_TEMPLATE_PATH.

Example screwdriver.yaml with validation and publishing:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - install: npm install screwdriver-template-main
            - validate: ./node_modules/.bin/template-validate
    publish:
        requires: main
        steps:
            - install: npm install screwdriver-template-main
            - publish: ./node_modules/.bin/template-publish --tag stable

template-publish can print a result as json by passing --json option to the command. template-publish will tag the published version as well. The default tag is latest if none is specified.

$ ./node_modules/.bin/template-publish --json
{name:"template/foo",version:"1.2.3",tag:"stable"}

Removing a template

To remove a template, run the template-remove script. You'll need to add an argument for the template name. Removing a template will remove all of its versions.

Example screwdriver.yaml with validation and publishing, and template removal as a detached job:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - install: npm install screwdriver-template-main
            - validate: ./node_modules/.bin/template-validate
    publish:
        requires: main
        steps:
            - install: npm install screwdriver-template-main
            - publish: ./node_modules/.bin/template-publish
    remove_template:
        steps:
            - install: npm install screwdriver-template-main
            - remove: ./node_modules/.bin/template-remove --name templateName

template-remove can print a result as json by passing --json option to the command.

$ ./node_modules/.bin/template-remove --json --name templateName
{"name":"templateName"}

Removing a template version

To remove a specific version of a template, run the template-remove-version binary. This must be done in the same pipeline that published the template. You'll need to specify the template name and version as arguments. Removing a template version will remove all the tags associated with it.

Example screwdriver.yaml with validation, publishing and tagging, and version removal as a detached job:

shared:
    image: node:18
    steps:
        - init: npm install screwdriver-template-main
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: ./node_modules/.bin/template-validate
    publish:
        requires: main
        steps:
            - publish: ./node_modules/.bin/template-publish
            - tag: ./node_modules/.bin/template-tag --name templateName --version 1.0.0 --tag latest
    detached_remove_version:
        steps:
            - remove: ./node_modules/.bin/template-remove-version --name templateName --version 1.0.0

template-remove-version can print a result as json by passing --json option to the command.

Tagging a template

Optionally, tag a template using the template-tag script. This must be done in the same pipeline that published the template. You'll need to add arguments for the template name and tag. You can optionally specify a version; the version must be an exact version, not just a major or major.minor one. If omitted, the latest version will be tagged.

Example screwdriver.yaml with validation and publishing and tagging:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - install: npm install screwdriver-template-main
            - validate: ./node_modules/.bin/template-validate
    publish:
        requires: main
        steps:
            - install: npm install screwdriver-template-main
            - publish: ./node_modules/.bin/template-publish
            - tag: ./node_modules/.bin/template-tag --name templateName --version 1.2.3 --tag stable

template-tag can print a result as json by passing --json option to the command.

$ ./node_modules/.bin/template-tag --json --name templateName --version 1.2.3 --tag stable
{"name":"templateName","tag":"stable","version":"1.2.3"}

Removing a template tag

To remove a template tag, run the template-remove-tag binary. This must be done in the same pipeline that published the template. You'll need to specify the template name and tag as arguments.

Example screwdriver.yaml with validation, publishing and tagging, and tag removal as a detached job:

shared:
    image: node:18
    steps:
        - init: npm install screwdriver-template-main
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: ./node_modules/.bin/template-validate
    publish:
        requires: main
        steps:
            - publish: ./node_modules/.bin/template-publish
            - tag: ./node_modules/.bin/template-tag --name templateName --version 1.0.0 --tag latest
    detached_remove_tag:
        steps:
            - remove: ./node_modules/.bin/template-remove-tag --name templateName --tag latest

template-remove-tag can print a result as json by passing --json option to the command.

$ ./node_modules/.bin/template-remove-tag --json --name templateName --tag stable
{"name":"templateName","tag":"stable"}

Getting the version from a template tag

To get the version from a template tag, run the template-get-version-from-tag binary. This must be done in the same pipeline that published the template. You'll need to add arguments for the template name and tag.

Example screwdriver.yaml with validation, publishing and tagging, and getting a version as a detached job:

shared:
    image: node:18
    steps:
        - init: npm install screwdriver-template-main
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: ./node_modules/.bin/template-validate
    publish:
        requires: main
        steps:
            - publish: ./node_modules/.bin/template-publish
            - tag: ./node_modules/.bin/template-tag --name templateName --version 1.0.0 --tag latest
    detached_get_version_from_tag:
        steps:
            - get_version: ./node_modules/.bin/template-get-version-from-tag --name templateName --tag latest

Pipeline Templates

Validating a template

Run the pipeline-template-validate script. By default, the path ./sd-template.yaml will be read. However, a user can specify a custom path using the env variable: SD_TEMPLATE_PATH.

Example screwdriver.yaml:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: npx -y -p screwdriver-template-main pipeline-template-validate
        environment:
            SD_TEMPLATE_PATH: ./path/to/pipeline-template.yaml

pipeline-template-validate can print a result as json by passing --json option to the command.

$ ./node_modules/.bin/pipeline-template-validate --json
{"valid":true}

Usage with npx

$ npx -y -p screwdriver-template-main pipeline-template-validate
{"valid":true}

Publishing a pipeline template

Run the pipeline-template-publish script. By default, the path ./sd-template.yaml will be read. However, a user can specify a custom path using the env variable: SD_TEMPLATE_PATH.

Example screwdriver.yaml with validation and publishing:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: npx -y -p screwdriver-template-main pipeline-template-validate
    publish:
        requires: main
        steps:
            - publish: npx -y -p screwdriver-template-main pipeline-template-publish --tag stable

pipeline-template-publish can print a result as json by passing --json option to the command. pipeline-template-publish will tag the published version as well. The default tag is latest if none is specified.

$ ./node_modules/.bin/pipeline-template-publish --json
{namespace:"template", name:"foo",version:"1.2.3",tag:"stable"}

Usage with npx

$ npx -y -p screwdriver-template-main pipeline-template-publish --json
{namespace:"template", name:"foo",version:"1.2.3",tag:"stable"}

Removing a template

To remove a template, run the pipeline-template-remove script. You'll need to add an argument for the template namespace, name. Removing a template will remove all of its versions and tags.

Example screwdriver.yaml with validation and publishing, and template removal as a detached job:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: npx -y -p screwdriver-template-main pipeline-template-validate
    publish:
        requires: main
        steps:
            - publish: npx -y -p screwdriver-template-main pipeline-template-publish
    remove_template:
        steps:
            - remove: npx -y -p screwdriver-template-main pipeline-template-remove --namespace templateNamespace --name templateName

pipeline-template-remove can print a result as json by passing --json option to the command.

$ ./node_modules/.bin/pipeline-template-remove --json --namespace templateNamespace --name templateName 
{"namespace":"templateNamespace", "name":"templateName"}

Usage with npx

$ npx -y -p screwdriver-template-main pipeline-template-remove --json --namespace templateNamespace --name templateName 
{"namespace":"templateNamespace", "name":"templateName"}

Removing a pipeline template version

To remove a specific version of a template, run the pipeline-template-remove-version binary. This must be done in the same pipeline that published the template. You'll need to specify the template namespace, name and version as arguments. Removing a template version will remove all the tags associated with it.

Example screwdriver.yaml with validation, publishing and tagging, and version removal as a detached job:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: npx -y -p screwdriver-template-main pipeline-template-validate
    publish:
        requires: main
        steps:
            - publish: npx -y -p screwdriver-template-main pipeline-template-publish
            - tag: npx -y -p screwdriver-template-main pipeline-template-tag --namespace templateNamespace --name templateName --version 1.0.0 --tag latest
    detached_remove_version:
        steps:
            - remove: npx -y -p screwdriver-template-main pipeline-template-remove-version --namespace templateNamespace --name templateName --version 1.0.0

pipeline-template-remove-version can print a result as json by passing --json option to the command.

Tagging a template

Optionally, tag a template using the pipeline-template-tag script. This must be done in the same pipeline that published the template. You'll need to add arguments for the template namespace, name and tag. You can optionally specify a version; the version must be an exact version, not just a major or major.minor one. If omitted, the latest version will be tagged.

Example screwdriver.yaml with validation and publishing and tagging:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: npx -y -p screwdriver-template-main pipeline-template-validate
    publish:
        requires: main
        steps:
            - publish: npx -y -p screwdriver-template-main pipeline-template-publish
            - tag: npx -y -p screwdriver-template-main pipeline-template-tag --namespace templateNamespace --name templateName --version 1.2.3 --tag stable

pipeline-template-tag can print a result as json by passing --json option to the command.

$ npx -y -p screwdriver-template-main pipeline-template-tag --json --name templateName --version 1.2.3 --tag stable
{"namespace":"templateNamespace", "name":"templateName","tag":"stable","version":"1.2.3"}

Removing a template tag

To remove a template tag, run the pipeline-template-remove-tag binary. This must be done in the same pipeline that published the template. You'll need to specify the template name and tag as arguments.

Example screwdriver.yaml with validation, publishing and tagging, and tag removal as a detached job:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: ./node_modules/.bin/pipeline-template-validate
    publish:
        requires: main
        steps:
            - publish: ./node_modules/.bin/pipeline-template-publish
            - tag: ./node_modules/.bin/pipeline-template-tag --namespace templateNamespace --name templateName --version 1.0.0 --tag latest
    detached_remove_tag:
        steps:
            - remove: ./node_modules/.bin/pipeline-template-remove-tag --namespace templateNamespace --name templateName --tag latest

pipeline-template-remove-tag can print a result as json by passing --json option to the command.

$ npx -y -p screwdriver-template-main pipeline-template-remove-tag --json --namespace templateNamespace --name templateName --tag stable
{"namespace":"templateNamespace", "name":"templateName","tag":"stable"}

Getting the version from a template tag

To get the version from a template tag, run the pipeline-template-get-version-from-tag binary. This must be done in the same pipeline that published the template. You'll need to add arguments for the template name and tag.

Example screwdriver.yaml with validation, publishing and tagging, and getting a version as a detached job:

shared:
    image: node:18
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: npx -y -p screwdriver-template-main pipeline-template-validate
    publish:
        requires: main
        steps:
            - publish: npx -y -p screwdriver-template-main pipeline-template-publish
            - tag: npx -y -p screwdriver-template-main pipeline-template-tag --namespace templateNamespace --name templateName --version 1.0.0 --tag latest
    detached_get_version_from_tag:
        steps:
            - get_version: npx -y -p screwdriver-template-main pipeline-template-get-version-from-tag --namespace templateNamespace --name templateName --tag latest

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.

screwdriver-template-main dependencies

js-yaml nomnom screwdriver-request

screwdriver-template-main development dependencies

chai eslint eslint-config-screwdriver mocha mocha-multi-reporters mocha-sonarqube-reporter mockery nyc sinon

FAQs

What is screwdriver-template-main?

Validates, publishes, and tags templates. Visit Snyk Advisor to see a full health score report for screwdriver-template-main, including popularity, security, maintenance & community analysis.

Is screwdriver-template-main popular?

The npm package screwdriver-template-main receives a total of 198 weekly downloads. As such, screwdriver-template-main popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is screwdriver-template-main well maintained?

We found indications that screwdriver-template-main maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is screwdriver-template-main safe to use?

While scanning the latest version of screwdriver-template-main, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 16 November-2024, at 05:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (198)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

template-main

Usage

Validating a template

Publishing a template

Removing a template

Removing a template version

Tagging a template

Removing a template tag

Getting the version from a template tag

Pipeline Templates

Validating a template

Publishing a pipeline template

Removing a template

Removing a pipeline template version

Tagging a template

Removing a template tag

Getting the version from a template tag

Testing

License

screwdriver-template-main dependencies

screwdriver-template-main development dependencies

FAQs

What is screwdriver-template-main?

Is screwdriver-template-main popular?

Is screwdriver-template-main well maintained?

Is screwdriver-template-main safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues