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.

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

Docs/reviewer add footer #319

Merged
merged 8 commits into from Feb 27, 2022
Expand Up @@ -28,8 +28,7 @@ When reviewing:

After merging:

- Do the MOCs need updating? See [[Updating MOC files]]
- Does the [tree of directories in Contributing](https://github.com/obsidian-community/obsidian-hub/blob/main/CONTRIBUTING.md#structure-of-the-community-vault) need to be updated? See comments in the source of that file.
- Run the [[update_hub GitHub Action]]. See here [[GitHub Actions for the Hub#^3df057|what it does]].
- If a directory was renamed (rare), check to see if you need delete the previous MOC

%% Hub footer: Please don't edit anything below this line %%
Expand Down
@@ -0,0 +1,29 @@
---
aliases:
-
tags:
-
---

# Adding footers

The script `add_footer.py` examines the current Hub vault contents and adds the footers if needed.

## Running the script

To run it:

```bash
cd obsidian-hub/.github/scripts
python3 ./add_footer.py
```

And then review the changes and commit them.
kometenstaub marked this conversation as resolved.
Show resolved Hide resolved

This can be done by hand, but we also have a [[update_hub GitHub Action|GitHub Action]] that runs it. However, this action [[GitHub Actions for the Hub#^3df057|executes other update scripts as well]].

%% Hub footer: Please don't edit anything below this line %%

# This note in GitHub

<span class="git-footer">[Edit In GitHub](https://github.dev/obsidian-community/obsidian-hub/blob/main/00%20-%20Contribute%20to%20the%20Obsidian%20Hub/03%20Contributor%20Notes/03.03%20Scripts%20and%20Automation/Adding%20footers.md "git-hub-edit-note") | [Copy this note](https://raw.githubusercontent.com/obsidian-community/obsidian-hub/main/00%20-%20Contribute%20to%20the%20Obsidian%20Hub/03%20Contributor%20Notes/03.03%20Scripts%20and%20Automation/Adding%20footers.md "git-hub-copy-note") | [Download this vault](https://github.com/obsidian-community/obsidian-hub/archive/refs/heads/main.zip "git-hub-download-vault") </span>
Expand Up @@ -7,6 +7,8 @@ tags:

# GitHub Actions for the Hub

One GitHub Action that combines updating theme download counts, adds new plugins, themes and authors, [[Updating MOC files|updates MOC files]], updates the [tree of directories in Contributing](https://github.com/obsidian-community/obsidian-hub/blob/main/00%20-%20Contribute%20to%20the%20Obsidian%20Hub/03%20Contributor%20Notes/03.01%20Structure/Hub%20Tree%20Structure.md) and [[Adding footers|adds footers]] is the [[update_hub GitHub Action]]. ^3df057

## Potentially automatable

There are some maintenance steps that are currently done manually, and that could be run automatically, either on a cron schedule, or upon changes to the main branch.
Expand Down
@@ -0,0 +1,24 @@
---
aliases:
-
tags:
- seedling
publish: true
---

# update_hub GitHub Action

Links to Action:

- Source of the workflow: [`update_hub.yml`](https://github.com/obsidian-community/obsidian-hub/blob/main/.github/workflows/update_hub.yml)
kometenstaub marked this conversation as resolved.
Show resolved Hide resolved
- Logs from runs of workflow: [`update_hub`](https://github.com/obsidian-community/obsidian-hub/actions/workflows/update_hub.yml)

Running this action will automatically create a Pull Request.

To see the associated Pull Request created from a successful run, expanding the run's log and click on the 'Show Pull Request' step.
kometenstaub marked this conversation as resolved.
Show resolved Hide resolved

%% Hub footer: Please don't edit anything below this line %%

# This note in GitHub

<span class="git-footer">[Edit In GitHub](https://github.dev/obsidian-community/obsidian-hub/blob/main/00%20-%20Contribute%20to%20the%20Obsidian%20Hub/03%20Contributor%20Notes/03.03%20Scripts%20and%20Automation/update_hub%20GitHub%20Action.md "git-hub-edit-note") | [Copy this note](https://raw.githubusercontent.com/obsidian-community/obsidian-hub/main/00%20-%20Contribute%20to%20the%20Obsidian%20Hub/03%20Contributor%20Notes/03.03%20Scripts%20and%20Automation/update_hub%20GitHub%20Action.md "git-hub-copy-note") | [Download this vault](https://github.com/obsidian-community/obsidian-hub/archive/refs/heads/main.zip "git-hub-download-vault") </span>
Expand Up @@ -13,10 +13,12 @@ In this folder, you can find notes about the scripting and automation processes
## MOC

%% Hub MOCs: Don’t edit below %%
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/Adding footers|Adding footers]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/Checking Hub Content|Checking Hub Content]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/GitHub Actions for the Hub|GitHub Actions for the Hub]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/Scripts for Maintenance|Scripts for Maintenance]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/Testing Python Code with Approval Tests|Testing Python Code with Approval Tests]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/update_hub GitHub Action|update_hub GitHub Action]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/Updating Extensions|Updating Extensions]]
- [[00 - Contribute to the Obsidian Hub/03 Contributor Notes/03.03 Scripts and Automation/Updating MOC files|Updating MOC files]]
%% Hub MOCs: Don’t edit above %%
Expand Down