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

Documentation, texinfo manual, readme generation #31

Merged
merged 4 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions .github/flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions .github/flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@
# needed by your repo after cloning.
epkgs.elpaPackages.project
epkgs.melpaPackages.auto-compile
epkgs.melpaPackages.license-templates

# Optionally override derivations.
# melpaPackages.weechat.overrideAttrs(old: {
# # probably you want to override the src attribute
# patches = [ ./weechat-el.patch ];
# })
]))
];
});
Expand Down
22 changes: 17 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
## Pull Requests

Generated changes to the flake.lock should be kept in a separate commit for the
reviewer. Title your commit as "generated".
**Generated** changes to the documentation and flake.lock should be kept in a
separate commit for the reviewer. Title your commit as "generated".

Keeping these changes isolated in specific commits makes it much easier to pull
in your changes in parallel with other features. Maintainers may harvest your
changes. We only guarantee to preserve authorship, signature, and sign-off in
the git log.
in your changes in parallel with other features.

Maintainers may harvest your changes. We only guarantee to preserve authorship,
signature, and sign-off in the git log.

### Creating pull requests

Expand All @@ -18,3 +19,14 @@ the git log.
checkbox)
1. Once the pull request has been approved, you will be thanked and observe your
changes applied with authorship, signature, and sign-off in the git log

### Reminder about PR access to upstream CI

Pull-requests run with the `pull_request_target` Github Actions configuration.
Your PR can access secrets, but it run's the **upstream's** CI, not the CI
changes you are submitting.

If you need to make changes to CI itself in order to pass checks, you will need
to work with the repository's owner. The owner will pull the branch into a
non-master branch. There, they can trigger the CI manually with the branch's
own configuration using `workflow_dispatch` in the Actions tab.
2 changes: 1 addition & 1 deletion .github/run-shim.el
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

;; Copyright (C) 2022 Positron Solutions

;; Author: <author>
;; Author: Positron Solutions <[email protected]>

;; 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
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ jobs:
os: [ubuntu-latest, macos-latest]
emacsPkg: [ emacs, emacsGit, ]
runs-on: ${{ matrix.os }}
# If you update steps, be sure to update the approved actions list in the
# manual and in your repositories!
steps:
- uses: actions/[email protected]
with:
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
***autoloads.el
**trash
**~
**.~undo-tree
**.~undo-tree
/docs/manual.info
Loading