Skip to content

Conversation

splendidbug
Copy link
Collaborator

No description provided.

@splendidbug
Copy link
Collaborator Author

This PR contains changes related to the knowledge pack creation. Added tests and refactored the code

@svilupp
Copy link
Collaborator

svilupp commented Jun 20, 2024

One comment -- remove Manifest.toml from your tracked files and from this repo! It's an asset for exact reproducibility on your machine (not useful for others).

Read more here: https://modernjuliaworkflows.github.io/writing/#environments

@@ -1,7 +1,33 @@

using Test
urls = Vector{AbstractString}(["https://docs.julialang.org/en/v1/"])
Copy link
Collaborator

Choose a reason for hiding this comment

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

It's great that you're adding some test! It would make sense to add the Github CI to run every time you make a PR.

On the organization, created separate files in test/ folder that match the src/ script file you're testing. That makes it very easy to navigate for others.

@svilupp
Copy link
Collaborator

svilupp commented Jun 20, 2024

For the package structure and boilerplate, you'll benefit greatly if you create a templated repo with: https://github.com/JuliaCI/PkgTemplates.jl

Do it in a separate folder and then copy over some of the helpful things like docs/ folder, .github CI folder, etc...

It's much harder to set it all up manually! We can do it in our next call.

I tend to use the following template:

# code
using PkgTemplates

tpl = Template(;
    user="svilupp",
    dir=".",
    julia=v"1.10",
    plugins=[
        License(; name="MIT", path=nothing, destination="LICENSE"),
        Codecov(),
        Tests(;
            project=false,
            aqua=true,
            aqua_kwargs=NamedTuple()
        ),
        Readme(;
            destination="README.md",
            inline_badges=true
        ),
        GitHubActions(;
            destination="CI.yml",
            linux=true,
            osx=false,
            windows=false,
            x64=true,
            x86=false,
            coverage=true,
            extra_versions=["1.0", "1.9", "nightly"]
        ),
        CompatHelper(;
            destination="CompatHelper.yml",
            cron="0 0 1 * *"
        ),
        Documenter{GitHubActions}(;
            assets=String[],
            logo=Logo(),
            devbranch=nothing,
            edit_link=:devbranch,
            makedocs_kwargs=Dict{Symbol,Any}()
        ),
        Formatter(;
            style="sciml"
        )])
        ```
        (you need to change some values)
        
        Use like this: `generate("PromptingTools", tpl)`

@splendidbug splendidbug merged commit 4390d9d into main Jul 10, 2024
@splendidbug splendidbug deleted the knowledge_packs branch July 10, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants