An open API service indexing awesome lists of open source software.

https://github.com/tlylt/coded-clique

Hide your issue/comment content from the prying eyes of a casual visitor
https://github.com/tlylt/coded-clique

github github-actions

Last synced: 4 months ago
JSON representation

Hide your issue/comment content from the prying eyes of a casual visitor

Awesome Lists containing this project

README

          

# Coded Clique

[![GitHub CI](https://github.com/tlylt/coded-clique/actions/workflows/test.yml/badge.svg)](https://github.com/tlylt/coded-clique/actions/workflows/test.yml)

This action provides the following functionality for GitHub Actions users:

- Hide your issue/comment content from the prying eyes of a casual visitor

Before:

![Before](img/before.png)

After:

![After1](img/after1.png)
![After2](img/after2.png)

# Usage

```yaml
steps:
- name: Coded Clique
uses: tlylt/coded-clique@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
```

### Action inputs

| Name | Description | Default |
|------------|----------------------------------------------------------------------------------------------------|----------------|
| `token` | `GITHUB_TOKEN` (`issues: write`, `pull-requests: write`) or a `repo` scoped personal-access-token. | `GITHUB_TOKEN` |
| `encoding` | The encoding method to use: "base64" or "question". | `base64` |

For `GITHUB_TOKEN`, go to your repository's Settings > Actions > General, under "Workflows permissions", select "Read and write permissions" and save. With that, you can simply use `token: ${{ secrets.GITHUB_TOKEN }}`.

# Testing

```yaml
name: Test coded-clique

on:
issues:
types: [opened, edited]
issue_comment:
types: [created, edited]

jobs:
build:
runs-on: ubuntu-latest
name: test
steps:
- name: Coded Clique
uses: tlylt/coded-clique@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
```

# Cookbook

## Use encoding "question"

```yaml
name: Test coded-clique

on:
issues:
types: [opened, edited]
issue_comment:
types: [created, edited]

jobs:
build:
runs-on: ubuntu-latest
name: test
steps:
- name: Coded Clique
uses: tlylt/coded-clique@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
encoding: 'question'
```

# Development

Updates will be done on the main branch. When ready, tag and release according to semver.

# License

The scripts and documentation in this project are released under the [MIT License](LICENSE)