Annotation Type ConfigFile


  • @Target(PARAMETER)
    @Retention(RUNTIME)
    public @interface ConfigFile
    Marks a parameter as a configuration file to be fetched from the code repository, and optionally (if the parameter type is different from String) deserialized using Jackson.

    Configuration files are always retrieved from the default branch, but there is some flexibility as to which repository the files are retrieved from in the case of forks, see source().

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value  
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      ConfigFile.Source source  
    • Element Detail

      • value

        String value
        Returns:
        The path to the file in the code repository, either absolute (if it starts with /) or relative to /.github/ (if it doesn't start with /).
      • source

        ConfigFile.Source source
        Returns:
        Which repository to extract the file from in the case of forked repositories.
        See Also:
        ConfigFile.Source
        Default:
        io.quarkiverse.githubapp.ConfigFile.Source.DEFAULT