diff --git a/assets/README.md b/assets/README.md index df8fca5eb..3bfea9b8f 100644 --- a/assets/README.md +++ b/assets/README.md @@ -3,7 +3,7 @@ This directory contains the go-ipfs assets: * Getting started documentation (`init-doc`). -* Directory listing HTML template (`dir-index-html` git submodule). +* Directory listing HTML template (`dir-index-html`). These assets are compiled into `bindata.go` with `go generate`. @@ -16,37 +16,4 @@ assets directory: ``` go generate . -``` - -## Updating dir-index-html - -Upstream: https://github.com/ipfs/dir-index-html - -dir-index-html is a git submodule. To update, run the following commands from -this directory. - -```bash -> git -C dir-index-html pull -> git -C dir-index-html checkout vX.Y.Z # target version -``` - -Then, you'll need to commit the updated submodule _before_ regenerating -`bindata.go`. Otherwise, `go generate` will checkout the checked-in version of -dir-index-html. - -```bash -> git add dir-index-html -> git commit -m 'chore: update dir-index-html to vX.Y.Z' -``` - -Finally, re-generate the directory index HTML template, tidy, and amend the previous -commit. - -```bash -> go generate . -> git add bindata.go -> git add bindata_version_hash.go -> go mod tidy -> git commit --amend --no-edit - -``` +``` \ No newline at end of file diff --git a/assets/assets.go b/assets/assets.go index e8893c635..d8bf49a00 100644 --- a/assets/assets.go +++ b/assets/assets.go @@ -1,4 +1,4 @@ -//go:generate git submodule update --init ./dir-index-html +//go:generate npm run build --prefix ./dir-index-html/ //go:generate go run github.com/go-bindata/go-bindata/v3/go-bindata -mode=0644 -modtime=1403768328 -pkg=assets init-doc dir-index-html/dir-index.html dir-index-html/knownIcons.txt //go:generate gofmt -s -w bindata.go //go:generate sh -c "sed -i \"s/.*BindataVersionHash.*/BindataVersionHash=\\\"$(git hash-object bindata.go)\\\"/\" bindata_version_hash.go" diff --git a/assets/dir-index-html/.github/ISSUE_TEMPLATE/config.yml b/assets/dir-index-html/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 4b86d7197..000000000 --- a/assets/dir-index-html/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,8 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: Getting Help on IPFS - url: https://ipfs.io/help - about: All information about how and where to get help on IPFS. - - name: IPFS Official Forum - url: https://discuss.ipfs.io - about: Please post general questions, support requests, and discussions here. diff --git a/assets/dir-index-html/.github/ISSUE_TEMPLATE/open_an_issue.md b/assets/dir-index-html/.github/ISSUE_TEMPLATE/open_an_issue.md deleted file mode 100644 index 4fcbd00ac..000000000 --- a/assets/dir-index-html/.github/ISSUE_TEMPLATE/open_an_issue.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Open an issue -about: Only for actionable issues relevant to this repository. -title: '' -labels: need/triage -assignees: '' - ---- - diff --git a/assets/dir-index-html/.github/config.yml b/assets/dir-index-html/.github/config.yml deleted file mode 100644 index ed26646a0..000000000 --- a/assets/dir-index-html/.github/config.yml +++ /dev/null @@ -1,68 +0,0 @@ -# Configuration for welcome - https://github.com/behaviorbot/welcome - -# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome -# Comment to be posted to on first time issues -newIssueWelcomeComment: > - Thank you for submitting your first issue to this repository! A maintainer - will be here shortly to triage and review. - - In the meantime, please double-check that you have provided all the - necessary information to make this process easy! Any information that can - help save additional round trips is useful! We currently aim to give - initial feedback within **two business days**. If this does not happen, feel - free to leave a comment. - - Please keep an eye on how this issue will be labeled, as labels give an - overview of priorities, assignments and additional actions requested by the - maintainers: - - - "Priority" labels will show how urgent this is for the team. - - "Status" labels will show if this is ready to be worked on, blocked, or in progress. - - "Need" labels will indicate if additional input or analysis is required. - - Finally, remember to use https://discuss.ipfs.io if you just need general - support. - -# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome -# Comment to be posted to on PRs from first time contributors in your repository -newPRWelcomeComment: > - Thank you for submitting this PR! - - A maintainer will be here shortly to review it. - - We are super grateful, but we are also overloaded! Help us by making sure - that: - - * The context for this PR is clear, with relevant discussion, decisions - and stakeholders linked/mentioned. - - * Your contribution itself is clear (code comments, self-review for the - rest) and in its best form. Follow the [code contribution - guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines) - if they apply. - - Getting other community members to do a review would be great help too on - complex PRs (you can ask in the chats/forums). If you are unsure about - something, just leave us a comment. - - Next steps: - - * A maintainer will triage and assign priority to this PR, commenting on - any missing things and potentially assigning a reviewer for high - priority items. - - * The PR gets reviews, discussed and approvals as needed. - - * The PR is merged by maintainers when it has been approved and comments addressed. - - We currently aim to provide initial feedback/triaging within **two business - days**. Please keep an eye on any labelling actions, as these will indicate - priorities and status of your contribution. - - We are very grateful for your contribution! - - -# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge -# Comment to be posted to on pull requests merged by a first time user -# Currently disabled -#firstPRMergeComment: "" diff --git a/assets/dir-index-html/.github/workflows/build.yml b/assets/dir-index-html/.github/workflows/build.yml deleted file mode 100644 index 100a5af8b..000000000 --- a/assets/dir-index-html/.github/workflows/build.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Build -on: [push, pull_request] - -jobs: - no-uncommitted-changes: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - ref: ${{ github.head_ref }} - - name: Run Build - uses: actions/setup-node@v1 - with: - node-version: '12.x' - - run: npm run build - - name: Check working tree - id: changes - uses: UnicornGlobal/has-changes-action@v1.0.11 - - name: Check for uncommited changes - if: steps.changes.outputs.changed == 1 - run: git status && git --no-pager diff --patch-with-raw && echo "Output does not match src/, uncommitted changes exist, follow build instructions from README" && exit 1 diff --git a/assets/dir-index-html/.gx/lastpubver b/assets/dir-index-html/.gx/lastpubver deleted file mode 100644 index ed0dfe62b..000000000 --- a/assets/dir-index-html/.gx/lastpubver +++ /dev/null @@ -1 +0,0 @@ -1.0.4: QmT1jwrqzSMjSjLG5oBd9w4P9vXPKQksWuf5ghsE3Q88ZV diff --git a/assets/dir-index-html/CHANGELOG.md b/assets/dir-index-html/CHANGELOG.md deleted file mode 100644 index 47e8bd555..000000000 --- a/assets/dir-index-html/CHANGELOG.md +++ /dev/null @@ -1,54 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [v1.2.0] - 2020-08-03 -This release streamlines the process for making future updates to this repo: - -- Moves source-of-truth HTML and CSS files into new `src` directory ([details](https://github.com/ipfs/dir-index-html/pull/40#issue-456530181)) -- Adds build script in `package.json` to generate minified/inlined `dir-index.html` at top level from individual files in `src` directory ([details](https://github.com/ipfs/dir-index-html/pull/40#issue-456530181)) -- Adds GitHub Action to guard against committing state where `dir-index.html` does not match source materials in `src` ([details](https://github.com/ipfs/dir-index-html/pull/40#pullrequestreview-456126397)) - -## [v1.1.0] - 2020-07-24 -This release brings general tidying, plus some substantial UI enhancements! Big thanks to @neatonk for all the work. - -- Adds a column for CIDs between the name and size columns; CIDs are clickable links that open the item as a new "root path", enabling users to copy direct links to images or subdirectories (see https://github.com/ipfs/dir-index-html/issues/37 and https://github.com/ipfs/dir-index-html/issues/15) -- Adds the size of the current directory to the header of the table (see https://github.com/ipfs/dir-index-html/issues/37 and https://github.com/ipfs/dir-index-html/issues/25) -- Makes path components in table headers into links, so clicking on segments between directory slashes will go to that level of the directory tree (see https://github.com/ipfs/dir-index-html/issues/37 and https://github.com/ipfs/dir-index-html/issues/2) -- Updates tests to include testing the above (see https://github.com/ipfs/dir-index-html/pull/38) -- Reconciles legacy discrepancies between `dir-index.html` and `dir-index-uncat.html` (see https://github.com/ipfs/dir-index-html/pull/39) - - -## [v1.0.6] - 2020-06-25 -- Adds favicon: visual consistency/prettiness, but more importantly prevents 404 error on an implicit /favicon.ico (see [#35](https://github.com/ipfs/dir-index-html/issues/35)) -- Adds social sharing metadata (see [#34](https://github.com/ipfs/dir-index-html/issues/34)) -- Updates contributing link in readme (thanks @stensonb!) - - -## [v1.0.5] - 2020-05-05 - -- Removes extraneous references to Glyphicons (closes [#23](https://github.com/ipfs/dir-index-html/issues/23)) -- Makes page responsive overall (closes [#24](https://github.com/ipfs/dir-index-html/issues/24)) -- Adds file icons for .wmv, .mov, .mkv (closes [#19](https://github.com/ipfs/dir-index-html/issues/19)) -- Strips out unneeded CSS -- Makes colors more accessible consistent with those in ipfs-css -- Tidies up in general - - -## [v1.0.4] - 2020-04-21 -- Update style to match IPFS branding -- Add links to ipfs.io, install help, and the bug tracker - - -## [v1.0.3] - 2016-08-31 -- No release notes added - - -## [v1.0.2] - 2016-08-31 -- No release notes added - - -## [v1.0.1] - 2016-08-31 -- No release notes added diff --git a/assets/dir-index-html/LICENSE b/assets/dir-index-html/LICENSE deleted file mode 100644 index ff6874839..000000000 --- a/assets/dir-index-html/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2016 IPFS - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/assets/dir-index-html/README.md b/assets/dir-index-html/README.md index c6d240bb1..969fa8c9f 100644 --- a/assets/dir-index-html/README.md +++ b/assets/dir-index-html/README.md @@ -17,14 +17,7 @@ When making updates to the directory listing page template, please note the following: 1. Make your changes to the (human-friendly) source documents in the `src` directory -2. Before testing or releasing, make sure to run the build script to update the minified version in the top-level directory: - -```bash -> npm run build -``` -3. To get your updates into `go-ipfs`, you'll need to do the following: - - Cut a new, appropriately versioned release of `dir-index-html` (don't forget to bump the version number in `package.json`) - - Make a PR against `go-ipfs` following [these instructions](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index +2. Before testing or releasing, make sure to run the `go generate .` script to update the minified version in the top-level `./assets` directory ## Testing @@ -39,16 +32,3 @@ This will listen on [`localhost:3000`](http://localhost:3000/) and reload the te If you get a "no such file or directory" error upon trying `go run .`, make sure you ran `npm run build` to generate the minified artifact that the test is looking for. -## Contribute - -Feel free to join in. All are welcome! A good place to start is to check the [issues](https://github.com/ipfs/dir-index-html/issues) for anything you find interesting. - -This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). - -### Want to hack on IPFS? - -[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) - -## License - -MIT diff --git a/assets/dir-index-html/test/go.mod b/assets/dir-index-html/test/go.mod index 272b57a14..fde71afe9 100644 --- a/assets/dir-index-html/test/go.mod +++ b/assets/dir-index-html/test/go.mod @@ -1,3 +1,3 @@ module github.com/ipfs/dir-index-html/test -go 1.14 +go 1.16