cypress-io / commit-info Goto Github PK

View Code? Open in Web Editor NEW

17.0 17.0 7.0 1.16 MB

Collects Git commit info using git

JavaScript 95.96% Dockerfile 0.46% Shell 3.58%

api cli commit git utility

commit-info's People

Contributors

Stargazers

Watchers

Forkers

godd9170 isabella232 nodejsfunc sindresvendby paramanandabiswal mikemcc399

commit-info's Issues

Travis CI build status not working / out of date

The status badge in this repository in the README.md file is using

[ci-image]: https://travis-ci.org/cypress-io/commit-info.svg?branch=master
[ci-url]: https://travis-ci.org/cypress-io/commit-info

The domain being addressed is travis-ci.org and https://docs.travis-ci.com/user/migrate/open-source-repository-migration states

"Starting June 2021 travis-ci.org is disabled and therefore no longer supported. Please use travis-ci.com."

At this moment the website is out of service:

$ curl -I https://travis-ci.org/cypress-io/commit-info
HTTP/2 503
date: Wed, 29 Mar 2023 13:50:54 GMT
content-type: text/html
strict-transport-security: max-age=15724800; includeSubDomains
cf-cache-status: DYNAMIC
report-to: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=Igh70rKuqiiHOmskJSJGVYrgAoS4dgDtxvVsDRS2Tn3%2BaOh2dlvYQ4Fylrl7%2BeGUDx%2F%2FZIIr%2Br%2B8hHVyHz1JeWUjMhP39shvjiy0E6jO1PwfghRj7oQnVf50IUC51cGRAGcu5ZDfvNVkrH0Y"}],"group":"cf-nel","max_age":604800}
nel: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
server: cloudflare
cf-ray: 7af895a44f0939be-FRA
alt-svc: h3=":443"; ma=86400, h3-29=":443"; ma=86400

Suggestion

Migrate the respository to use a different CI provider.

See also cypress-io/cypress-example-kitchensink#602

Update getBranch to look for Jenkins branch name

Within the getBranch function, in order to get accurate Jenkins branch, should look for env var GIT_BRANCH.

Originally from issue cypress-io/cypress#2129

If any command returns empty return null

Breaking change!

Especially branch

Add bin command

To debug Git problems on different systems.

Should be simple equivalent to

$ node -e "require('@cypress/commit-info').commitInfo().then(console.log)"

Add methods to return subject and body of the message

In addition to the method that returns the entire message

Expose getRemoteOrigin and other individual methods

sometimes we want just a single value

Dependency deprecation warning: nsp (npm)

On registry https://registry.npmjs.org/, the "latest" version (v3.2.1) of dependency nsp has the following deprecation notice:

The Node Security Platform service is shutting down 9/30 - https://blog.npmjs.org/post/175511531085/the-node-security-platform-service-is-shutting

Marking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.

Affected package file(s): package.json

If you don't care about this, you can close this issue and not be warned about nsp's deprecation again. If you would like to completely disable all future deprecation warnings then add the following to your config:

"suppressNotifications": ["deprecationWarningIssues"]

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

File: renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: Invalid regExp for packageRules[0].packagePatterns: ^@cypress, Invalid regExp for packageRules[3].packagePatterns: ^@types, Invalid regExp for packageRules[4].packagePatterns: ^sinon, Invalid regExp for packageRules[5].packagePatterns: ^gulp, Invalid regExp for packageRules[6].packagePatterns: ^eslint``

Do not change process.cwd()

Just pass it as an option to execa.

commit-info/src/git-api.js

Line 30 in 7bac92d

const runGit = () => execa.shell(gitCommand).then(prop('stdout'))

Also FWIW the .tap(...) call to change back process.cwd will not be called if the promise throws, resulting in a mutated process.cwd

Add docker example

To show how to pass environment variables to a Docker container

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

WARN: Found renovate config warnings

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

fix(deps): update dependency lazy-ass to version 2.x 🌟

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Detected dependencies

dockerfile

docker-example/Dockerfile

github-actions

.github/workflows/main.yml

actions/checkout v3

actions/setup-node v3

npm

package.json

bluebird 3.7.2

check-more-types 2.24.0

debug 4.3.4

execa 1.0.0

lazy-ass 1.6.0

ramda 0.26.1

ban-sensitive-files 1.10.0

chdir-promise 0.6.2

dependency-check 4.1.0

deps-ok 1.4.1

dont-crack 1.2.1

git-issues 1.3.1

github-post-release 1.13.1

license-checker 25.0.1

mocha 6.2.1

mocked-env 1.3.1

pre-git 3.17.1

prettier-standard 8.0.1

semantic-release 17.2.3

simple-commit-message 4.1.3

snap-shot-it 7.9.3

standard 13.1.0

stub-spawn-once 2.3.0

Check this box to trigger a request for Renovate to run again on this repository

Add fallback environment variables

For really weird environments (like Docker containers WITHOUT git), we can have fallback environment variables we can check if git calls fail. For example we could polyfill failed keys with these environment variables

branch: COMMIT_INFO_BRANCH
message: COMMIT_INFO_MESSAGE
email: COMMIT_INFO_EMAIL
author: COMMIT_INFO_AUTHOR
sha: COMMIT_INFO_SHA
remote: COMMIT_INFO_REMOTE

then anyone who is spawning a container can set these environment variables themselves and get useful info