From 5fa8818a20519ff662904ca499443f6ea5db860f Mon Sep 17 00:00:00 2001 From: R4SAS Date: Sat, 14 Jan 2023 22:07:12 +0000 Subject: [PATCH] Update repository description (#8) --- .editorconfig | 25 +++++++++ .github/workflows/test-snap-can-build.yml | 25 +++++++++ README.md | 68 ++++++++++++++--------- snap/snapcraft.yaml | 14 ++--- 4 files changed, 96 insertions(+), 36 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/workflows/test-snap-can-build.yml diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e72cc33 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,25 @@ +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = false +insert_final_newline = false + +[*.yaml] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.yml] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.github/workflows/test-snap-can-build.yml b/.github/workflows/test-snap-can-build.yml new file mode 100644 index 0000000..3b909c8 --- /dev/null +++ b/.github/workflows/test-snap-can-build.yml @@ -0,0 +1,25 @@ +name: 🧪 Test snap can be built on x86_64 + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - uses: snapcore/action-build@v1 + id: build + + - uses: diddlesnaps/snapcraft-review-action@v1 + with: + snap: ${{ steps.build.outputs.snap }} + isClassic: 'false' + # Plugs and Slots declarations to override default denial (requires store assertion to publish) + # plugs: ./plug-declaration.json + # slots: ./slot-declaration.json diff --git a/README.md b/README.md index c778af1..e2ad88b 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,23 @@ i2pd - Invisible Internet Protocol Daemon -

This is the snap for i2pd, "Invisible Internet Protocol Daemon". It works on Ubuntu, Fedora, Debian, and other major Linux +

This is the snap for i2pd, “Invisible Internet Protocol Daemon”. It works on Ubuntu, Fedora, Debian, and other major Linux distributions.

-Snap Status + + enpass + + + enpass +

-

Published for :penguin: with :gift_heart: by Snapcrafters

+

Published for with 💝 by Snapcrafters

## Install - sudo apt install snapd-xdg-open - sudo snap install --edge i2pd + sudo snap install i2pd [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/i2pd) @@ -44,41 +48,53 @@ Reload config after changing `tunnels.conf` file: ## Remaining tasks -Snapcrafters ([join us](https://forum.snapcraft.io/t/join-snapcrafters/1325)) -are working to land snap install documentation and -the [snapcraft.yaml](https://github.com/snapcrafters/fork-and-rename-me/blob/master/snap/snapcraft.yaml) -upstream so [i2pd](https://github.com/PurpleI2P/i2pd) can authoritatively publish future releases. +Snapcrafters ([join us](https://forum.snapcraft.io/t/snapcrafters-reboot/24625)) are working to land snap install documentation and the [snapcraft.yaml](https://github.com/snapcrafters/fork-and-rename-me/blob/master/snap/snapcraft.yaml) upstream so [Project] can authoritatively publish future releases. - - [x] Fork the [Snapcrafters template](https://github.com/snapcrafters/fork-and-rename-me) repository to your own GitHub account. - - If you have already forked the Snapcrafter template to your account and want to create another snap, you'll need to use GitHub's [Import repository](https://github.com/new/import) feature because you can only fork a repository once. - - [x] Rename the forked Snapcrafters template repository + - [x] Click the green "Use this template" button above to create a new repository based on this template + - [x] Give the newly created repository a sensible name, like `godzilla` if you're snapping the Godzilla software (*Note: Do not use `snap` in this name.*) + - [x] Update the description of the repository to `Official snap for i2pd` - [x] Update logos and references to `[Project]` and `[my-snap-name]` - [x] Create a snap that runs in `devmode` + - [x] Convert the snap to `strict` confinement, or `classic` confinement if it qualifies - [x] Register the snap in the store, **using the preferred upstream name** - - [x] Add a screenshot to this `README.md` - - [x] Publish the `devmode` snap in the Snap store edge channel + - [ ] Add a screenshot to this `README.md` - [x] Add install instructions to this `README.md` - [x] Update snap store metadata, icons and screenshots - - [x] Convert the snap to `strict` confinement, or `classic` confinement if it qualifies - [x] Publish the confined snap in the Snap store beta channel - [x] Update the install instructions in this `README.md` - - [ ] Post a call for testing on the [Snapcraft Forum](https://forum.snapcraft.io) - [link]() - - [ ] Ask a [Snapcrafters admin](https://github.com/orgs/snapcrafters/people?query=%20role%3Aowner) to fork your repo into github.com/snapcrafters, transfer the snap name from you to snapcrafters, and configure the repo for automatic publishing into edge on commit + - [ ] Post a call for testing in the Snapcraft Forum ["Snapcrafters" category](https://forum.snapcraft.io/c/snapcrafters/23) - [link]() + - [ ] Add the Snapcraft store account (snap-advocacy@canonical.com) as a collaborator to your snap in the [Dashboard](https://dashboard.snapcraft.io) and ask a [Snapcrafters admin](https://github.com/orgs/snapcrafters/people?query=%20role%3Aowner) to accept this request + - [ ] Fix all important issues found during testing + - [ ] Make a post in the Snapcraft Forum ["store-requests" category](https://forum.snapcraft.io/c/store-requests/19) asking for a transfer of the snap name from you to Snapcrafters - [link]() + - [ ] Ask a [Snapcrafters admin](https://github.com/orgs/snapcrafters/people?query=%20role%3Aowner) to fork your repo into github.com/snapcrafters, and configure the repo for automatic publishing into edge on commit - [x] Add the provided Snapcraft build badge to this `README.md` - [x] Publish the snap in the Snap store stable channel - [x] Update the install instructions in this `README.md` - - [ ] Post an announcement in the [Snapcraft Forum](https://forum.snapcraft.io) - [link]() - - [x] Submit a pull request or patch upstream that adds snap install documentation - [link]() - - [x] Submit a pull request or patch upstream that adds the `snapcraft.yaml` and any required assets/launchers - [link]() - - [ ] Add upstream contact information to the `README.md` - - If upstream accept the PR: - - [ ] Request upstream create a Snap store account - - [ ] Contact the Snap Advocacy team to request the snap be transferred to upstream + - [ ] Post an announcement in the Snapcraft Forum ["Snapcrafters" category](https://forum.snapcraft.io/c/snapcrafters/23) - [link]() - [ ] Ask the Snap Advocacy team to celebrate the snap - [link]() + - [x] Submit a pull request or patch upstream that adds snap install documentation - [link]() + - [ ] Ask upstream if they are interested in maintaining the Snap. If they are: + - [ ] Fork the upstream project, add the snap build files and required assets/launchers to that repo and submit a pull request or patch - [link]() + - [ ] Add upstream contact information to the `README.md` + - If upstream accept the PR: + - [ ] Request upstream create a Snap store account + - [ ] Add upstream account as a collaborator on the snap + - [ ] Contact the Snap Advocacy team to request the snap be transferred to upstream If you have any questions, [post in the Snapcraft forum](https://forum.snapcraft.io). ## The Snapcrafters -[l-n-s](https://github.com/l-n-s/) -[r4sas](https://github.com/r4sas/) +| [![l-n-s](https://gravatar.com/avatar/bc0bced65e963eb5c3a16cab8b004431/?s=128)](https://github.com/l-n-s/) | +| [![r4sas](https://gravatar.com/avatar/bc0bced65e963eb5c3a16cab8b004431/?s=128)](https://github.com/r4sas/) | +| :---: | +| [l-n-s](https://github.com/l-n-s/) | +| [r4sas](https://github.com/r4sas/) | + + \ No newline at end of file diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml index dc2fab8..103aef9 100644 --- a/snap/snapcraft.yaml +++ b/snap/snapcraft.yaml @@ -1,19 +1,13 @@ -# -## Easiest way to work with this file, from an updated Ubuntu 16.04 LTS image -## 1. create a non-root user with sudo priv and perform following steps as non-root -## 2. `sudo apt-get update` -## 3. `sudo apt-get install snapcraft python build-essential` -## 4. `snapcraft stage` -## 5. `snapcraft snap` - name: i2pd version: 2.45.1 summary: Distributed anonymous networking framework description: | i2pd (I2P Daemon) is a full-featured C++ implementation of I2P client. - I2P (Invisible Internet Protocol) is a universal anonymous network layer. + I2P (Invisible Internet Protocol) is a universal anonymous network layer. All communications over I2P are anonymous and end-to-end encrypted, - participants don't reveal their real IP addresses. + participants don't reveal their real IP addresses. + +base: core18 icon: i2pd-logo.png type: app