Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: remove error when content limit exceeded #71

Merged
merged 1 commit into from Aug 18, 2022
Merged

feat: remove error when content limit exceeded #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Expand Up @@ -23,9 +23,14 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
| `username` | (**required**) Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository. | |
| `password` | (**required**) Docker Hub password or [Personal Access Token](https://docs.docker.com/docker-hub/access-tokens/) with `read/write/delete` scope. | |
| `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` |
| `short-description` | Docker Hub repository short description. Input exceeding 100 characters will be truncated. | |
| `short-description` | Docker Hub repository short description. | |
| `readme-filepath` | Path to the repository readme. | `./README.md` |

#### Content limits

DockerHub has content limits, which if exceeded will result in the content being automatically truncated.
The readme content is limited to 25,000 bytes, and `short-description` is limited to 100 characters.

#### Specifying the file path

The action assumes that there is a file called `README.md` located at the root of the repository.
Expand Down
4 changes: 1 addition & 3 deletions action.yml
View file
Open in desktop
Expand Up @@ -13,9 +13,7 @@ inputs:
Docker Hub repository in the format `<namespace>/<name>`
Default: `github.repository`
short-description:
description: >
Docker Hub repository short description
Input exceeding 100 characters will be truncated
description: Docker Hub repository short description
readme-filepath:
description: >
Path to the repository readme
Expand Down
5 changes: 0 additions & 5 deletions dist/index.js
View file
Open in desktop
Expand Up @@ -212,7 +212,6 @@ const inputHelper = __importStar(__nccwpck_require__(480));
const dockerhubHelper = __importStar(__nccwpck_require__(812));
const fs = __importStar(__nccwpck_require__(147));
const util_1 = __nccwpck_require__(837);
const MAX_BYTES = 25000;
function run() {
return __awaiter(this, void 0, void 0, function* () {
try {
Expand All @@ -223,10 +222,6 @@ function run() {
const readmeContent = yield fs.promises.readFile(inputs.readmeFilepath, {
encoding: 'utf8'
});
const byteLength = new util_1.TextEncoder().encode(readmeContent).length;
if (byteLength > MAX_BYTES) {
throw new Error(`File size exceeds the maximum allowed ${MAX_BYTES} bytes`);
}
// Acquire a token for the Docker Hub API
core.info('Acquiring token');
const token = yield dockerhubHelper.getToken(inputs.username, inputs.password);
Expand Down
10 changes: 1 addition & 9 deletions src/main.ts
View file
Open in desktop
Expand Up @@ -2,9 +2,7 @@ import * as core from '@actions/core'
import * as inputHelper from './input-helper'
import * as dockerhubHelper from './dockerhub-helper'
import * as fs from 'fs'
import {inspect, TextEncoder} from 'util'

const MAX_BYTES = 25000
import {inspect} from 'util'

async function run(): Promise<void> {
try {
Expand All @@ -17,12 +15,6 @@ async function run(): Promise<void> {
const readmeContent = await fs.promises.readFile(inputs.readmeFilepath, {
encoding: 'utf8'
})
const byteLength = new TextEncoder().encode(readmeContent).length
if (byteLength > MAX_BYTES) {
throw new Error(
`File size exceeds the maximum allowed ${MAX_BYTES} bytes`
)
}

// Acquire a token for the Docker Hub API
core.info('Acquiring token')
Expand Down