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.

Sign up for GitHub

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

Jump to bottom

[INFRA] Integrate feedback of the first release #48

Merged
merged 19 commits into from
Sep 7, 2021
Merged

[INFRA] Integrate feedback of the first release #48

merged 19 commits into from
Sep 7, 2021

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Sep 2, 2021 •
edited
Loading

Integrate feedback from

  • 1st manual package generation
  • 1st submission rejection ([FEAT] Submit the package to CRAN #10 (comment))
    • description title: use title case
    • do not package the README.md file: it generates warnings because of unreachable links (contributing.md not in the package)
    • do not package the doc folder: only needed for the README.md file, non standard folder
  • the github worklow now builds the source package and run checks on it as done during the CRAN submission to detect errors earlier

Also read: https://jef.works/blog/2018/06/18/get-your-package-on-cran-in-10-steps/

Covers #10

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Sep 2, 2021
@tbouffard
CRAN submission: simplify and remove screenshots
4c9867f 
screenshots increase the package source bundle (we could ignore the files in
RbuildIgnore) and are not useful: there is enough information provided by
the linked contents.
@tbouffard
DESCRIPTION: title in title case
fa4fb6b
@tbouffard
Rbuildignore: add all md files and the doc directory
46d67f7 
Don't package for now, this will be review when working on the documentation
@tbouffard
More info for solution 2
85ab8fb
@tbouffard tbouffard mentioned this pull request Sep 6, 2021
Closed
8 tasks
@tbouffard tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Sep 7, 2021
@tbouffard tbouffard changed the title [DOC] Integrate feedback of the first release [INFRA] Integrate feedback of the first release Sep 7, 2021
@tbouffard tbouffard removed the documentation Improvements or additions to documentation label Sep 7, 2021
@tbouffard tbouffard requested a review from csouchet September 7, 2021 11:41
@tbouffard tbouffard marked this pull request as ready for review September 7, 2021 11:41
csouchet
csouchet reviewed Sep 7, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
csouchet
csouchet reviewed Sep 7, 2021
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@tbouffard tbouffard merged commit 6dcc48d into main Sep 7, 2021
@tbouffard tbouffard deleted the doc/release_process_improvements branch September 7, 2021 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@csouchet csouchet csouchet approved these changes

Assignees
No one assigned
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tbouffard @csouchet