@action-badges/core - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "@action-badges/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Create SVG badges with GitHub actions",
@@ -23,3 +23,3 @@ "main": "src/index.js",
     "@actions/core": "^1.2.7",
-    "@actions/github": "^4.0.0",
+    "@actions/github": "^5.0.0",
     "badge-maker": "^3.3.0"
@@ -26,0 +26,0 @@ },

README.md

@@ -1,3 +0,19 @@
-# TODO
+# action-badges/core
 
+Serverless badge generation with Github Actions
+
 [![Run tests](https://github.com/action-badges/core/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/action-badges/core/actions/workflows/test.yml) [![Build Dist](https://github.com/action-badges/core/actions/workflows/build-dist.yml/badge.svg?branch=main)](https://github.com/action-badges/core/actions/workflows/build-dist.yml)
+
+Action badges allows you to create custom badges using github actions and host them in your own github repo.
+
+Unlike centralized services like [shields.io](https://shields.io/) and [badgen.net](https://badgen.net/), action badges can be used to:
+
+- Generate badges using content in private repositories without hosting and maintaining your own instance of shields or badgen
+- Make badges that need private tokens or secrets to generate the content
+- Make badges that are slow to compute or rely on data that is not available from a HTTP API
+- Generate badges without contacting any external services: compute is handled by github actions, badges are stored in github repo
+
+There are two ways to use action-badges/core. It can be used directly as a Github Action to generate badges with yaml workflows or as an NPM library to create re-usable javascript actions.
+
+- [Github Action](https://github.com/action-badges/core/blob/main/docs/github-action.md)
+- [NPM Package](https://github.com/action-badges/core/blob/main/docs/npm-package.md)

src/github.js

@@ -25,3 +25,3 @@ "use strict";
   try {
-    const resp = await client.repos.getContent({
+    const resp = await client.rest.repos.getContent({
       owner,
@@ -57,3 +57,3 @@ repo,
   if (content !== existingFile.content) {
-    await client.repos.createOrUpdateFileContents(payload);
+    await client.rest.repos.createOrUpdateFileContents(payload);
     return true;
@@ -60,0 +60,0 @@ }

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19066

141.62%

Number of package files

15

114.29%

Number of lines in readme file

20

400%

Number of medium supply chain risk alerts

0

-100%

Dependency changes

• + Added

  @actions/github@5.1.1
  (transitive)

• + Added

  @octokit/plugin-rest-endpoint-methods@5.16.2
  (transitive)

• - Removed

  @actions/github@4.0.0
  (transitive)

• - Removed

  @actions/http-client@1.0.11
  (transitive)

• - Removed

  @octokit/plugin-rest-endpoint-methods@4.15.1
  (transitive)

• Updated

  @actions/github@^5.0.0