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

iconic-salmon-fa:1.0.0 #575

Merged
merged 1 commit into from
May 16, 2024
Merged

iconic-salmon-fa:1.0.0 #575

merged 1 commit into from
May 16, 2024

Conversation

Bi0T1N
Copy link
Contributor

@Bi0T1N Bi0T1N commented Apr 20, 2024

I am submitting

  • a new package
  • an update for a package

Description: This is the renamed version of the socialhub-fa (#218) package with the new name introduced in #536. It also fixes a small inconsistency in the generated example PDF (different icon for GitLab due to initially wrong build environment).

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE
  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

@Bi0T1N
Copy link
Contributor Author

Bi0T1N commented Apr 20, 2024

Is there a process defined on how to remove or deprecate the existing socialhub-fa package?

@laurmaedje laurmaedje added the new A new package submission. label Apr 29, 2024
Copy link
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two import statements that should be changed, but other than that it looks good. Thanks!

@@ -0,0 +1,104 @@
#import "../iconic-salmon-fa.typ": *
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This import should use the package specification:

Suggested change
#import "../iconic-salmon-fa.typ": *
#import "@preview/iconic-salmon-fa:1.0.0": *

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any hard requirement for this? I see that several other packages also reference the local version (which btw is the only way to access a new version to generate a new PDF file before publishing)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it is not a hard requirement. It is just better because then people can copy/paste your example and start from here. It also makes it easier to tell which version of the package is used if the file is given out-of-context.
I agree that this is however not ideal to generate PDF files. The best solution as far as I know is to generate them with the relative import, and then update it to use the package import before submitting here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's why I have included the instructions in the README.md 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'll merge it as is then.

@@ -0,0 +1,4 @@
// #import "@preview/iconic-salmon-fa:1.0.0": github-info, gitlab-info
#import "../iconic-salmon-fa.typ": github-info, gitlab-info
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here:

Suggested change
#import "../iconic-salmon-fa.typ": github-info, gitlab-info
#import "@preview/iconic-salmon-fa:1.0.0": github-info, gitlab-info

@elegaanz
Copy link
Member

elegaanz commented May 2, 2024

Is there a process defined on how to remove or deprecate the existing socialhub-fa package?

What you could do is to publish a new minor version of socialhub-fa, that only edits the contents of the README.md to tell to use this package instead.
There isn't a proper way to deprecate packages for the moment, but once it will be implemented we will notify you.

@reknih reknih force-pushed the main branch 6 times, most recently from 92aab43 to d06d87c Compare May 15, 2024 10:12
@elegaanz elegaanz merged commit ec43214 into typst:main May 16, 2024
1 check passed
@Bi0T1N Bi0T1N deleted the iconic-salmon-fa branch May 16, 2024 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new A new package submission.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants